From d0cf4d95abd84139fd39fbd2a76c0c09fb4bad83 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 12:39:25 -0500 Subject: [PATCH 01/28] tasks --- tasks.json | 192 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 192 insertions(+) create mode 100644 tasks.json diff --git a/tasks.json b/tasks.json new file mode 100644 index 000000000..acc325855 --- /dev/null +++ b/tasks.json @@ -0,0 +1,192 @@ +[ + { + "category": "schema-contract", + "description": "Extend the MetaEd API Schema OpenAPI document contract so `projectSchema.openApiBaseDocuments.changeQueries` can be emitted as an optional core-only base document.", + "acceptance-criteria": [ + "`OpenApiDocumentType` and related `NamespaceEdfiApiSchema` and `ProjectSchema` types accept a `changeQueries` document key alongside `resources` and `descriptors`.", + "Core/data-standard namespaces can carry `openApiBaseDocuments.changeQueries`; extension namespaces do not emit that standalone base document.", + "`ApiSchemaBuildingEnhancer` copies the optional `changeQueries` base document into core `projectSchema.openApiBaseDocuments` without adding the key to extension project schemas.", + "The existing `resources` and `descriptors` base document behavior remains unchanged except for explicit snapshot cleanup handled in a separate task.", + "`apiSchemaVersion` remains `1.0.0` because the new document is OpenAPI-only metadata under `openApiBaseDocuments`.", + "All new or changed exported types and functions have summary JSDoc comments and explicit TypeScript annotations." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", + "Run `npx tsc -p packages/metaed-plugin-edfi-api-schema --noEmit` from the repository root.", + "Review a generated core ApiSchema JSON artifact under `packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm `projectSchema.openApiBaseDocuments.changeQueries` is present only for the core project." + ], + "completed": false + }, + { + "category": "openapi-generation", + "description": "Generate the standalone Change-Queries OpenAPI base document that advertises `GET /availableChangeVersions` for DMS metadata discovery.", + "acceptance-criteria": [ + "The core `openApiBaseDocuments.changeQueries` document contains the ODS-style path key `/availableChangeVersions`, not `/changeQueries/v1/availableChangeVersions`.", + "The `GET /availableChangeVersions` operation exposes a `200` `application/json` object response with required `oldestChangeVersion` and `newestChangeVersion` integer `int64` properties.", + "The `GET /availableChangeVersions` operation does not include resource or descriptor query parameters such as `minChangeVersion`, `maxChangeVersion`, `limit`, `offset`, `totalCount`, `pageToken`, or `pageSize`.", + "The standalone document does not include resource or descriptor paths, and resource/descriptor documents do not include `/availableChangeVersions`.", + "The standalone document does not emit deployment-specific OAuth2 security schemes, root `security`, token URLs, or runtime server URLs that DMS must inject at serve time.", + "The standalone document does not include snapshot headers, snapshot response descriptions, or snapshot-specific response components." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_3.test.ts` from the repository root after updating authoritative artifacts if generated artifacts changed.", + "Inspect `projectSchema.openApiBaseDocuments.changeQueries.paths` in a generated core ApiSchema artifact under `packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3` and confirm it contains only `/availableChangeVersions`." + ], + "completed": false + }, + { + "category": "openapi-generation", + "description": "Remove snapshot-only OpenAPI artifacts from the DMS OpenAPI documents emitted by `metaed-plugin-edfi-api-schema`.", + "acceptance-criteria": [ + "Generated resource, descriptor, and Change-Queries OpenAPI documents do not define or reference `Use-Snapshot` header parameters.", + "Generated resource, descriptor, and Change-Queries OpenAPI documents do not define or reference the shared `NotFoundUseSnapshot` response.", + "Generated GET-by-query and GET-by-id operations use non-snapshot not-found responses and descriptions.", + "Generated write and delete operation responses do not include snapshot-specific `405 Method Is Not Allowed` descriptions.", + "No generated OpenAPI fragment or base document contains the text `Use-Snapshot` or snapshot-only response wording." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", + "Search generated ApiSchema artifacts with `rg \"Use-Snapshot|NotFoundUseSnapshot|snapshot\" packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm remaining matches are outside DMS OpenAPI output or are intentionally unrelated model text." + ], + "completed": false + }, + { + "category": "semantic-modeling", + "description": "Build reusable OpenAPI schema generation for Change Query identity-key response payloads from existing semantic API Schema metadata.", + "acceptance-criteria": [ + "Regular resource tracked-change key schemas are derived by correlating exact `identityJsonPaths` values with `queryFieldMapping` and `QueryFieldPathInfo` source-property metadata, without parsing endpoint names, component names, or JSONPath segments.", + "Regular resource key schemas expose public query-field names for identity fields and omit internal storage identifiers.", + "Descriptor tracked-change key schemas use required public `namespace` and `codeValue` properties because descriptor `identityJsonPaths` is intentionally empty.", + "Descriptor-reference identity fields in regular resource key schemas are represented as public descriptor URI string fields rather than internal descriptor IDs.", + "Concrete abstract resources that materialize as endpoints derive tracked-change key schemas from their concrete resource schema and identity metadata, while abstract schema-only resources do not receive tracked-change response schemas.", + "`/deletes` item schemas require `id`, `changeVersion`, and `keyValues`; `/keyChanges` item schemas require `id`, `changeVersion`, `oldKeyValues`, and `newKeyValues`.", + "Every generated key object schema marks each identity property as required and uses the JSON schema type information available from existing API Schema metadata.", + "`changeVersion`, `minChangeVersion`, and `maxChangeVersion` are represented consistently as integer `int64` values." + ], + "steps-to-verify": [ + "Run focused unit tests for the new tracked-change schema helper, for example `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` or a new helper-specific test file from the repository root.", + "Review inline snapshots for a regular resource with scalar and reference identity fields.", + "Review inline snapshots for a descriptor and confirm only `namespace` and `codeValue` appear in key schemas." + ], + "completed": false + }, + { + "category": "openapi-generation", + "description": "Advertise live Change Query window filters on existing resource and descriptor GET-many OpenAPI operations.", + "acceptance-criteria": [ + "Every generated regular resource GET-many operation includes `minChangeVersion` and `maxChangeVersion` query parameters.", + "Every generated descriptor GET-many operation includes `minChangeVersion` and `maxChangeVersion` query parameters.", + "`SchoolYearType` GET-many OpenAPI output includes `minChangeVersion` and `maxChangeVersion` because it is treated as a regular Change Query resource.", + "Extension-defined top-level resource and descriptor GET-many operations include the same change-version query parameters under their extension project endpoint.", + "Resource-extension overlays under `_ext` do not receive standalone live Change Query filter parameters because they are not standalone endpoints.", + "The live GET-many parameters are not added to GET-by-id, POST, PUT, DELETE, `/deletes`, `/keyChanges`, or `/availableChangeVersions` operations through this task.", + "`minChangeVersion` and `maxChangeVersion` are represented consistently with the ChangeVersion contract as integer `int64` query parameters.", + "No `Use-Snapshot` parameter or snapshot-specific response is introduced while adding the live change-version parameters." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", + "Inspect generated resource and descriptor OpenAPI fragments for a core resource, descriptor, `SchoolYearType`, and extension-defined resource.", + "Search generated ApiSchema artifacts with `rg \"minChangeVersion|maxChangeVersion|Use-Snapshot\" packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm change-version parameters appear only on expected operations and `Use-Snapshot` is absent from DMS OpenAPI output." + ], + "completed": false + }, + { + "category": "openapi-generation", + "description": "Emit `/deletes` and `/keyChanges` OpenAPI paths for generated resources and descriptors that support Change Query discovery.", + "acceptance-criteria": [ + "Every non-composite generated regular resource in the resources OpenAPI fragments advertises `/{projectEndpointName}/{resourceEndpoint}/deletes` and `/{projectEndpointName}/{resourceEndpoint}/keyChanges`.", + "Every generated descriptor in the descriptors OpenAPI fragments advertises `/{projectEndpointName}/{descriptorEndpoint}/deletes` and `/{projectEndpointName}/{descriptorEndpoint}/keyChanges`.", + "`SchoolYearType` is treated as a regular Change Query resource and advertises both tracked-change paths.", + "Concrete abstract resources that materialize as endpoints advertise both tracked-change paths under their concrete endpoint names.", + "Extension-defined top-level resources and descriptors advertise tracked-change paths under their extension project endpoint.", + "Resource-extension overlays under `_ext` do not receive standalone `/deletes` or `/keyChanges` paths.", + "Abstract resources that do not materialize to endpoints continue to emit schemas only and do not receive tracked-change paths.", + "Tracked-change paths are emitted as `get` operations on sibling collection subpaths, not as operations under `/{id}` paths.", + "`/deletes` and `/keyChanges` operations include `minChangeVersion`, `maxChangeVersion`, `limit`, `offset`, and `totalCount` query parameters.", + "`/deletes` and `/keyChanges` operations expose `200` `application/json` array responses that reference the generated delete item and key-change item schemas." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/ApiSchemaBuildingEnhancer.test.ts` from the repository root if ResourceSchema copying behavior changes.", + "Inspect generated core and extension ApiSchema artifacts for representative resource, descriptor, `SchoolYearType`, and resource-extension cases." + ], + "completed": false + }, + { + "category": "profile-integration", + "description": "Make the MetaEd-emitted tracked-change OpenAPI fragments compatible with DMS profile-specific OpenAPI filtering and schema suffixing.", + "acceptance-criteria": [ + "Tracked-change response component names are deterministic and resource-specific so DMS can create profile-suffixed tracked-change schemas without colliding with normal resource representation schemas.", + "MetaEd emits stable unprofiled tracked-change component names and references; profile-specific suffixing remains DMS-owned.", + "The tracked-change key schemas contain only identity-key fields and are not shaped as readable or writable resource representations.", + "Generated resource paths make `/deletes` and `/keyChanges` clearly owned by their parent resource path so DMS can preserve them for readable profile resources.", + "The standalone `changeQueries` base document is emitted only as an unprofiled core document and is not duplicated through resource or descriptor fragments.", + "MetaEd unit or integration tests document the expected fragment shape that DMS profile filtering consumes." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", + "Review generated tracked-change component names for at least one core resource and one extension resource.", + "Review generated fragments and confirm `/deletes` and `/keyChanges` paths share the owning resource path prefix." + ], + "completed": false + }, + { + "category": "tests", + "description": "Add focused unit and integration coverage for the Change Query OpenAPI surface in `metaed-plugin-edfi-api-schema`.", + "acceptance-criteria": [ + "Unit tests cover standalone `changeQueries` base document creation, core-only emission, and the `/availableChangeVersions` response shape.", + "Unit tests cover `/deletes` and `/keyChanges` path generation for a regular resource, descriptor, concrete abstract resource, `SchoolYearType`, extension-defined top-level resource, and resource-extension overlay exclusion.", + "Unit tests cover required query parameters on tracked-change paths and live GET-many change-version parameters.", + "Unit tests cover regular-resource key schema derivation from identity metadata and descriptor key schema derivation from `namespace` and `codeValue`.", + "Tests assert that snapshot-specific OpenAPI artifacts are absent from generated DMS OpenAPI output.", + "Tests use inline snapshots where they verify full generated OpenAPI objects." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", + "Run any new focused test file added for Change Query OpenAPI helpers with `npx jest path/to/test.ts` from the repository root." + ], + "completed": false + }, + { + "category": "authoritative-artifacts", + "description": "Update the generated and authoritative ApiSchema integration artifacts to reflect the new Change Query OpenAPI contract.", + "acceptance-criteria": [ + "Core data-standard artifacts include `projectSchema.openApiBaseDocuments.changeQueries` with `/availableChangeVersions`.", + "Core data-standard artifacts include `/deletes` and `/keyChanges` fragments for regular resources, concrete abstract resources, descriptors, and `SchoolYearType`.", + "Extension artifacts include `/deletes` and `/keyChanges` fragments for extension-defined top-level resources and descriptors.", + "Extension artifacts do not include `projectSchema.openApiBaseDocuments.changeQueries`.", + "Updated artifacts contain strongly typed tracked-change response schemas and do not contain snapshot-only OpenAPI artifacts in DMS OpenAPI sections.", + "Updated artifacts preserve `apiSchemaVersion` and show only OpenAPI metadata changes expected by this story.", + "Authoritative compare tests pass for every supported API Schema integration suite whose output changes." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_1.test.ts` from the repository root if v7.1 artifacts change.", + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_2.test.ts` from the repository root if v7.2 artifacts change.", + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_3.test.ts` from the repository root.", + "Run `npx ts-node packages/metaed-plugin-edfi-api-schema/test/integration/update-authoritative-files.ts --dry-run` from the repository root to confirm the generated-to-authoritative copy set before updating authoritative files.", + "Review `git diff -- packages/metaed-plugin-edfi-api-schema/test/integration/artifact` before accepting the updates." + ], + "completed": false + }, + { + "category": "validation", + "description": "Validate the completed MetaEd OpenAPI output and package quality without running the repository publishing build.", + "acceptance-criteria": [ + "Merged resource, descriptor, and Change-Queries OpenAPI documents have no dangling `$ref` values introduced by the new tracked-change schemas or paths.", + "The `metaed-plugin-edfi-api-schema` package type check passes.", + "Directory-level ESLint passes for the package source and tests touched by the implementation.", + "No `npm run build` command is used.", + "The final implementation notes identify any generated artifact diffs that are expected because of the Change Query OpenAPI contract." + ], + "steps-to-verify": [ + "Run `npx tsc -p packages/metaed-plugin-edfi-api-schema --noEmit` from the repository root.", + "Run `npx eslint --max-warnings 0 --ext .js,.ts packages/metaed-plugin-edfi-api-schema/src packages/metaed-plugin-edfi-api-schema/test` from the repository root.", + "Run the focused Jest tests for the changed package with `npx jest path/to/test.ts` from the repository root.", + "Optionally validate merged OpenAPI documents with `@apidevtools/swagger-parser` if new full-document validation coverage is added." + ], + "completed": false + } +] From bf83378bb3369936afaa4fb9a943b4aa079ef350 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 12:46:05 -0500 Subject: [PATCH 02/28] tasks --- tasks.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/tasks.json b/tasks.json index acc325855..136514244 100644 --- a/tasks.json +++ b/tasks.json @@ -23,7 +23,7 @@ "acceptance-criteria": [ "The core `openApiBaseDocuments.changeQueries` document contains the ODS-style path key `/availableChangeVersions`, not `/changeQueries/v1/availableChangeVersions`.", "The `GET /availableChangeVersions` operation exposes a `200` `application/json` object response with required `oldestChangeVersion` and `newestChangeVersion` integer `int64` properties.", - "The `GET /availableChangeVersions` operation does not include resource or descriptor query parameters such as `minChangeVersion`, `maxChangeVersion`, `limit`, `offset`, `totalCount`, `pageToken`, or `pageSize`.", + "The `GET /availableChangeVersions` operation has no advertised query parameters, including resource or descriptor parameters such as `minChangeVersion`, `maxChangeVersion`, `limit`, `offset`, `totalCount`, `pageToken`, or `pageSize`.", "The standalone document does not include resource or descriptor paths, and resource/descriptor documents do not include `/availableChangeVersions`.", "The standalone document does not emit deployment-specific OAuth2 security schemes, root `security`, token URLs, or runtime server URLs that DMS must inject at serve time.", "The standalone document does not include snapshot headers, snapshot response descriptions, or snapshot-specific response components." @@ -61,6 +61,7 @@ "Descriptor tracked-change key schemas use required public `namespace` and `codeValue` properties because descriptor `identityJsonPaths` is intentionally empty.", "Descriptor-reference identity fields in regular resource key schemas are represented as public descriptor URI string fields rather than internal descriptor IDs.", "Concrete abstract resources that materialize as endpoints derive tracked-change key schemas from their concrete resource schema and identity metadata, while abstract schema-only resources do not receive tracked-change response schemas.", + "Tracked-change response item `id` properties are represented as strings.", "`/deletes` item schemas require `id`, `changeVersion`, and `keyValues`; `/keyChanges` item schemas require `id`, `changeVersion`, `oldKeyValues`, and `newKeyValues`.", "Every generated key object schema marks each identity property as required and uses the JSON schema type information available from existing API Schema metadata.", "`changeVersion`, `minChangeVersion`, and `maxChangeVersion` are represented consistently as integer `int64` values." @@ -98,6 +99,7 @@ "acceptance-criteria": [ "Every non-composite generated regular resource in the resources OpenAPI fragments advertises `/{projectEndpointName}/{resourceEndpoint}/deletes` and `/{projectEndpointName}/{resourceEndpoint}/keyChanges`.", "Every generated descriptor in the descriptors OpenAPI fragments advertises `/{projectEndpointName}/{descriptorEndpoint}/deletes` and `/{projectEndpointName}/{descriptorEndpoint}/keyChanges`.", + "Tracked-change endpoint advertisement is driven by generated resource and descriptor OpenAPI fragments, not by claim/action metadata, `ReadChanges` authorization strategies, or runtime tracked-change inventory.", "`SchoolYearType` is treated as a regular Change Query resource and advertises both tracked-change paths.", "Concrete abstract resources that materialize as endpoints advertise both tracked-change paths under their concrete endpoint names.", "Extension-defined top-level resources and descriptors advertise tracked-change paths under their extension project endpoint.", @@ -105,6 +107,8 @@ "Abstract resources that do not materialize to endpoints continue to emit schemas only and do not receive tracked-change paths.", "Tracked-change paths are emitted as `get` operations on sibling collection subpaths, not as operations under `/{id}` paths.", "`/deletes` and `/keyChanges` operations include `minChangeVersion`, `maxChangeVersion`, `limit`, `offset`, and `totalCount` query parameters.", + "`minChangeVersion` and `maxChangeVersion` query parameters use integer `int64`; `limit` and `offset` use integer `int32`; `totalCount` uses a boolean schema with default `false`, matching existing component parameter conventions.", + "`/deletes` and `/keyChanges` operations do not include cursor-paging parameters such as `pageToken` or `pageSize`, and do not inherit live resource query-field filters.", "`/deletes` and `/keyChanges` operations expose `200` `application/json` array responses that reference the generated delete item and key-change item schemas." ], "steps-to-verify": [ @@ -139,6 +143,7 @@ "Unit tests cover standalone `changeQueries` base document creation, core-only emission, and the `/availableChangeVersions` response shape.", "Unit tests cover `/deletes` and `/keyChanges` path generation for a regular resource, descriptor, concrete abstract resource, `SchoolYearType`, extension-defined top-level resource, and resource-extension overlay exclusion.", "Unit tests cover required query parameters on tracked-change paths and live GET-many change-version parameters.", + "Unit tests assert that tracked-change paths do not include cursor-paging parameters or live resource query-field filters.", "Unit tests cover regular-resource key schema derivation from identity metadata and descriptor key schema derivation from `namespace` and `codeValue`.", "Tests assert that snapshot-specific OpenAPI artifacts are absent from generated DMS OpenAPI output.", "Tests use inline snapshots where they verify full generated OpenAPI objects." From 9de6632e08a6eb07bd0e3223bcdc8695f5c03162 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 12:54:20 -0500 Subject: [PATCH 03/28] Add change queries OpenAPI base document contract --- .../src/enhancer/ApiSchemaBuildingEnhancer.ts | 9 +- .../enhancer/OpenApiBaseDocumentEnhancer.ts | 15 ++-- .../src/model/Namespace.ts | 16 +++- .../model/api-schema/OpenApiDocumentType.ts | 4 + .../src/model/api-schema/ProjectSchema.ts | 2 +- .../ApiSchemaBuildingEnhancer.test.ts | 84 +++++++++++++++++++ .../OpenApiBaseDocumentEnhancer.test.ts | 25 +++++- progress.txt | 5 ++ tasks.json | 2 +- 9 files changed, 147 insertions(+), 15 deletions(-) create mode 100644 progress.txt 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/OpenApiBaseDocumentEnhancer.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts index 1af606deb..41e437d1c 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts @@ -8,12 +8,13 @@ import { ComponentsObject, Document } 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.) */ -function createBaseOpenApiDocument(metaEd: MetaEdEnvironment, documentType: string): Document { +function createBaseOpenApiDocument(metaEd: MetaEdEnvironment, documentType: OpenApiDocumentTypeValue): Document { const components: ComponentsObject = { schemas: {}, responses: createHardcodedParameterResponses(), @@ -40,9 +41,12 @@ function createBaseOpenApiDocument(metaEd: MetaEdEnvironment, documentType: stri }; // 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; @@ -61,8 +65,9 @@ export function enhance(metaEd: MetaEdEnvironment): EnhancerResult { // Create base documents for resources and descriptors 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/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/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..0341cd4ec 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 @@ -54,6 +54,10 @@ import { enhance as identityJsonPathsEnhancer } from '../../src/enhancer/Identit 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 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]); @@ -3531,3 +3535,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 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/OpenApiBaseDocumentEnhancer.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts index 2fd14571b..b24fe2b19 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'); @@ -64,7 +65,7 @@ describe('OpenApiBaseDocumentEnhancer', () => { 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'); @@ -78,9 +79,25 @@ describe('OpenApiBaseDocumentEnhancer', () => { expect(descriptorsDoc?.tags).toEqual([]); }); + it('should create base document for change queries', () => { + const namespaceEdfiApiSchema = namespace?.data.edfiApiSchema as NamespaceEdfiApiSchema; + const changeQueriesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.CHANGE_QUERIES]; + + 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).toEqual({}); + expect(changeQueriesDoc?.components?.schemas).toEqual({}); + expect(changeQueriesDoc?.components?.responses).toBeDefined(); + expect(changeQueriesDoc?.components?.parameters).toBeDefined(); + 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(); @@ -89,7 +106,7 @@ describe('OpenApiBaseDocumentEnhancer', () => { 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(); diff --git a/progress.txt b/progress.txt new file mode 100644 index 000000000..56ba2359a --- /dev/null +++ b/progress.txt @@ -0,0 +1,5 @@ +2026-06-10 - Completed schema-contract for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: added changeQueries OpenAPI document type; OpenApiBaseDocumentEnhancer emits empty core-only changeQueries base doc; ApiSchemaBuildingEnhancer copies openApiBaseDocuments only for non-extension namespaces; apiSchemaVersion stays 1.0.0. +Files changed: OpenApiDocumentType.ts, Namespace.ts, ProjectSchema.ts, OpenApiBaseDocumentEnhancer.ts, ApiSchemaBuildingEnhancer.ts, OpenApiBaseDocumentEnhancer.test.ts, ApiSchemaBuildingEnhancer.test.ts, tasks.json, progress.txt. +Verification: OpenApiBaseDocumentEnhancer Jest, ApiSchemaBuildingEnhancer Jest, package tsc, package ESLint, generator spot-check core has resources/descriptors/changeQueries and extension omits openApiBaseDocuments. +Notes: authoritative artifact refresh intentionally deferred to authoritative-artifacts task; next task should populate /availableChangeVersions in changeQueries.paths. diff --git a/tasks.json b/tasks.json index 136514244..1b4598f1b 100644 --- a/tasks.json +++ b/tasks.json @@ -15,7 +15,7 @@ "Run `npx tsc -p packages/metaed-plugin-edfi-api-schema --noEmit` from the repository root.", "Review a generated core ApiSchema JSON artifact under `packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm `projectSchema.openApiBaseDocuments.changeQueries` is present only for the core project." ], - "completed": false + "completed": true }, { "category": "openapi-generation", From 8b379e52bd2a233e3521f6776f04ea5e8e7c182c Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 12:58:18 -0500 Subject: [PATCH 04/28] Add available change versions OpenAPI base path --- .../enhancer/OpenApiBaseDocumentEnhancer.ts | 71 +++++++++++++++++-- .../OpenApiBaseDocumentEnhancer.test.ts | 53 +++++++++++++- progress.txt | 5 ++ tasks.json | 2 +- 4 files changed, 121 insertions(+), 10 deletions(-) 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 41e437d1c..0b81a8d5c 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts @@ -4,22 +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: OpenApiDocumentTypeValue): 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', @@ -35,7 +94,7 @@ function createBaseOpenApiDocument(metaEd: MetaEdEnvironment, documentType: Open url: '', }, ], - paths: {}, + paths: documentType === OpenApiDocumentType.CHANGE_QUERIES ? createChangeQueriesPaths() : {}, components, tags: [], }; 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 b24fe2b19..a3ed6eec8 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 @@ -82,16 +82,63 @@ describe('OpenApiBaseDocumentEnhancer', () => { it('should create base document for change queries', () => { 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).toEqual({}); + 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).toBeDefined(); - expect(changeQueriesDoc?.components?.parameters).toBeDefined(); + 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('oauth2'); + expect(JSON.stringify(changeQueriesDoc)).not.toContain('tokenUrl'); expect(changeQueriesDoc?.tags).toEqual([]); }); diff --git a/progress.txt b/progress.txt index 56ba2359a..41aa6f564 100644 --- a/progress.txt +++ b/progress.txt @@ -3,3 +3,8 @@ Key decisions: added changeQueries OpenAPI document type; OpenApiBaseDocumentEnh Files changed: OpenApiDocumentType.ts, Namespace.ts, ProjectSchema.ts, OpenApiBaseDocumentEnhancer.ts, ApiSchemaBuildingEnhancer.ts, OpenApiBaseDocumentEnhancer.test.ts, ApiSchemaBuildingEnhancer.test.ts, tasks.json, progress.txt. Verification: OpenApiBaseDocumentEnhancer Jest, ApiSchemaBuildingEnhancer Jest, package tsc, package ESLint, generator spot-check core has resources/descriptors/changeQueries and extension omits openApiBaseDocuments. Notes: authoritative artifact refresh intentionally deferred to authoritative-artifacts task; next task should populate /availableChangeVersions in changeQueries.paths. + +2026-06-10 - Completed openapi-generation availableChangeVersions for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: changeQueries base doc now specializes paths/components; emits only ODS-style /availableChangeVersions path; 200 body has required oldestChangeVersion/newestChangeVersion integer int64; no inherited query params, snapshot components, OAuth/security. +Files changed: OpenApiBaseDocumentEnhancer.ts, OpenApiBaseDocumentEnhancer.test.ts, tasks.json, progress.txt. +Verification: OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint. Authoritative artifact refresh still deferred to authoritative-artifacts task. diff --git a/tasks.json b/tasks.json index 1b4598f1b..040c4e618 100644 --- a/tasks.json +++ b/tasks.json @@ -33,7 +33,7 @@ "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_3.test.ts` from the repository root after updating authoritative artifacts if generated artifacts changed.", "Inspect `projectSchema.openApiBaseDocuments.changeQueries.paths` in a generated core ApiSchema artifact under `packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3` and confirm it contains only `/availableChangeVersions`." ], - "completed": false + "completed": true }, { "category": "openapi-generation", From 006d3fdb16e0bc7a080e096945dd971bb29e8694 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 13:05:19 -0500 Subject: [PATCH 05/28] Add Change Query tracked-change schemas --- .../src/enhancer/IdentityJsonPathsEnhancer.ts | 5 + .../OpenApiChangeQuerySchemaBuilder.ts | 311 +++++++++++++++++ .../OpenApiResourceFragmentEnhancer.ts | 11 +- .../src/model/EntityApiSchemaData.ts | 1 + .../IdentityJsonPathsEnhancer.test.ts | 30 ++ .../OpenApiChangeQuerySchemaBuilder.test.ts | 314 ++++++++++++++++++ progress.txt | 6 + tasks.json | 2 +- 8 files changed, 677 insertions(+), 3 deletions(-) create mode 100644 packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts create mode 100644 packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts 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/OpenApiChangeQuerySchemaBuilder.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts new file mode 100644 index 000000000..e1a71edf5 --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts @@ -0,0 +1,311 @@ +// 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 EntityProperty, + type IntegerProperty, + type StringProperty, + type TopLevelEntity, +} from '@edfi/metaed-core'; +import type { EntityApiSchemaData } from '../model/EntityApiSchemaData'; +import type { JsonPath } from '../model/api-schema/JsonPath'; +import type { PathType } from '../model/api-schema/PathType'; +import type { QueryFieldMapping } from '../model/api-schema/QueryFieldMapping'; +import type { QueryFieldPathInfo } from '../model/api-schema/QueryFieldPathInfo'; +import type { SchemaObject, Schemas } from '../model/OpenApiTypes'; +import { deAcronym, normalizeDescriptorName } from '../Utility'; + +/** + * 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; +}; + +/** + * Query field path information matched to a public query field name. + */ +type QueryFieldPathInfoMatch = { + fieldName: string; + pathInfo: QueryFieldPathInfo; +}; + +/** + * 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 + ); +} + +/** + * Creates a fallback schema from API Schema path type metadata. + */ +function schemaObjectFromPathType(pathType: PathType): SchemaObject { + switch (pathType) { + case 'boolean': + return { type: 'boolean' }; + case 'date': + return { type: 'string', format: 'date' }; + case 'date-time': + return { type: 'string', format: 'date-time' }; + case 'number': + return { type: 'number', format: 'double' }; + case 'string': + return { type: 'string' }; + case 'time': + return { type: 'string' }; + default: + return { type: 'string' }; + } +} + +/** + * Creates an OpenAPI schema object from source property semantic type metadata. + */ +function schemaObjectFromSourceProperty(sourceProperty: EntityProperty): SchemaObject { + switch (sourceProperty.type) { + case 'boolean': + return { type: 'boolean' }; + 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 'duration': + return { type: 'string', maxLength: 30 }; + case 'integer': + case 'sharedInteger': { + const integerProperty: IntegerProperty = sourceProperty 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 stringProperty: StringProperty = sourceProperty as StringProperty; + const result: SchemaObject = { type: 'string' }; + 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: 'string' }; + } +} + +/** + * Creates an OpenAPI schema object from query field path metadata. + */ +function schemaObjectFromQueryFieldPathInfo(pathInfo: QueryFieldPathInfo): SchemaObject { + if (pathInfo.sourceProperty == null) return schemaObjectFromPathType(pathInfo.type); + + return schemaObjectFromSourceProperty(pathInfo.sourceProperty); +} + +/** + * Finds public query field path info by exact identity JSON path match. + */ +function queryFieldPathInfoMatching( + identityJsonPath: JsonPath, + queryFieldMapping: QueryFieldMapping, +): QueryFieldPathInfoMatch | undefined { + const matchingQueryFieldEntry: [string, QueryFieldPathInfo[]] | undefined = Object.entries(queryFieldMapping).find( + ([, pathInfos]: [string, QueryFieldPathInfo[]]) => + pathInfos.some((pathInfo: QueryFieldPathInfo) => pathInfo.path === identityJsonPath), + ); + if (matchingQueryFieldEntry == null) return undefined; + + const [fieldName, pathInfos] = matchingQueryFieldEntry; + const matchingPathInfo: QueryFieldPathInfo | undefined = pathInfos.find( + (pathInfo: QueryFieldPathInfo) => pathInfo.path === identityJsonPath, + ); + if (matchingPathInfo == null) return undefined; + + return { fieldName, pathInfo: matchingPathInfo }; +} + +/** + * Creates public identity field schemas for a regular resource from identity and query-field metadata. + */ +function identityFieldSchemasFrom(entity: TopLevelEntity): IdentityFieldSchema[] { + const entityApiSchemaData: EntityApiSchemaData = entity.data.edfiApiSchema as EntityApiSchemaData; + const identityJsonPaths: JsonPath[] = entityApiSchemaData.identityJsonPaths ?? []; + const includedFieldNames: Set = new Set(); + const result: IdentityFieldSchema[] = []; + + identityJsonPaths.forEach((identityJsonPath: JsonPath) => { + const match: QueryFieldPathInfoMatch | undefined = queryFieldPathInfoMatching( + identityJsonPath, + entityApiSchemaData.queryFieldMapping, + ); + if (match == null || includedFieldNames.has(match.fieldName)) return; + + includedFieldNames.add(match.fieldName); + result.push({ + fieldName: match.fieldName, + schema: schemaObjectFromQueryFieldPathInfo(match.pathInfo), + }); + }); + + return result; +} + +/** + * 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); + }); + + return { + type: 'object', + required, + 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)); + + if (keyValuesSchema.required == null || keyValuesSchema.required.length === 0) return {}; + + 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/OpenApiResourceFragmentEnhancer.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts index 7ce40c234..2be104fed 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts @@ -17,6 +17,7 @@ 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'; /** * Creates an OpenAPI fragment for a resource entity @@ -24,7 +25,10 @@ import { deAcronym } from '../Utility'; export function createResourceFragment(entity: TopLevelEntity): OpenApiFragment { const fragment: OpenApiFragment = { components: { - schemas: createSchemasFrom(entity), + schemas: { + ...createSchemasFrom(entity), + ...createTrackedChangeSchemasFrom(entity), + }, }, }; @@ -45,7 +49,10 @@ function createDescriptorFragment(entity: TopLevelEntity): OpenApiFragment { return { paths: createPathsFrom(entity), components: { - schemas: createSchemasFrom(entity), + schemas: { + ...createSchemasFrom(entity), + ...createTrackedChangeSchemasFrom(entity), + }, }, tags: createTagsFrom(entity), }; 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..dd38df929 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/model/EntityApiSchemaData.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/model/EntityApiSchemaData.ts @@ -284,6 +284,7 @@ export function addEntityApiSchemaDataTo(entity: ModelBase) { endpointName: '' as EndpointName, resourceName: '' as MetaEdResourceName, identityFullnames: [], + identityJsonPaths: [], queryFieldMapping: {}, namespaceSecurableElements: [], educationOrganizationSecurableElements: [], 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/OpenApiChangeQuerySchemaBuilder.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts new file mode 100644 index 000000000..d3691796b --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts @@ -0,0 +1,314 @@ +// 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 { JsonPath } from '../../src/model/api-schema/JsonPath'; +import type { QueryFieldMapping } from '../../src/model/api-schema/QueryFieldMapping'; + +/** + * 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 descriptor source property for tracked-change schema tests. + */ +function descriptorSourceProperty(): EntityProperty { + return { + ...newEntityProperty(), + type: 'descriptor', + documentation: 'Entry grade level descriptor', + }; +} + +/** + * Creates regular resource query field mapping metadata for tracked-change schema tests. + */ +function regularResourceQueryFieldMapping(): QueryFieldMapping { + return { + entryGradeLevelDescriptor: [ + { + path: '$.entryGradeLevelDescriptor' as JsonPath, + type: 'string', + sourceProperty: descriptorSourceProperty(), + }, + ], + internalEntryGradeLevelDescriptorId: [ + { + path: '$.entryGradeLevelDescriptorId' as JsonPath, + type: 'number', + sourceProperty: integerSourceProperty(), + }, + ], + schoolId: [ + { + path: '$.schoolReference.schoolId' as JsonPath, + type: 'number', + sourceProperty: integerSourceProperty(), + }, + ], + studentUniqueId: [ + { + path: '$.studentReference.studentUniqueId' as JsonPath, + type: 'string', + sourceProperty: stringSourceProperty(), + }, + ], + }; +} + +/** + * Creates a top-level entity with only the data needed by tracked-change schema generation. + */ +function topLevelEntityWith( + type: string, + metaEdName: string, + isAbstract: boolean, + queryFieldMapping: QueryFieldMapping, +): TopLevelEntity { + return { + type, + metaEdName, + isAbstract, + namespace: { + namespaceName: 'EdFi', + }, + data: { + edfiApiSchema: { + identityJsonPaths: [ + '$.entryGradeLevelDescriptor' as JsonPath, + '$.schoolReference.schoolId' as JsonPath, + '$.studentReference.studentUniqueId' as JsonPath, + ], + queryFieldMapping, + }, + }, + } as unknown as TopLevelEntity; +} + +describe('OpenApiChangeQuerySchemaBuilder', () => { + describe('when creating schemas for a regular resource', () => { + const entity: TopLevelEntity = topLevelEntityWith( + 'association', + 'StudentSchoolAssociation', + false, + regularResourceQueryFieldMapping(), + ); + + 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 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, + regularResourceQueryFieldMapping(), + ); + + 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, + regularResourceQueryFieldMapping(), + ); + + it('should not create tracked-change schemas', () => { + expect(createTrackedChangeSchemasFrom(entity)).toMatchInlineSnapshot(`Object {}`); + }); + }); +}); diff --git a/progress.txt b/progress.txt index 41aa6f564..4e1cdb846 100644 --- a/progress.txt +++ b/progress.txt @@ -8,3 +8,9 @@ Notes: authoritative artifact refresh intentionally deferred to authoritative-ar Key decisions: changeQueries base doc now specializes paths/components; emits only ODS-style /availableChangeVersions path; 200 body has required oldestChangeVersion/newestChangeVersion integer int64; no inherited query params, snapshot components, OAuth/security. Files changed: OpenApiBaseDocumentEnhancer.ts, OpenApiBaseDocumentEnhancer.test.ts, tasks.json, progress.txt. Verification: OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint. Authoritative artifact refresh still deferred to authoritative-artifacts task. + +2026-06-10 - Completed semantic-modeling tracked-change schemas for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: added reusable OpenApiChangeQuerySchemaBuilder; exact identityJsonPaths-to-queryFieldMapping matching; descriptor keys are namespace/codeValue; descriptor references stay public URI strings; abstract resources emit no tracked-change schemas; SchoolYear gets semantic $.schoolYear identity metadata. +Files changed: OpenApiChangeQuerySchemaBuilder.ts, OpenApiResourceFragmentEnhancer.ts, IdentityJsonPathsEnhancer.ts, EntityApiSchemaData.ts, OpenApiChangeQuerySchemaBuilder.test.ts, IdentityJsonPathsEnhancer.test.ts, tasks.json, progress.txt. +Verification: OpenApiChangeQuerySchemaBuilder Jest, OpenApiResourceFragmentEnhancer Jest, IdentityJsonPathsEnhancer Jest, package tsc, package ESLint. +Notes: components now exist for later /deletes and /keyChanges path wiring; authoritative artifact refresh still deferred. diff --git a/tasks.json b/tasks.json index 040c4e618..ac9b23f70 100644 --- a/tasks.json +++ b/tasks.json @@ -71,7 +71,7 @@ "Review inline snapshots for a regular resource with scalar and reference identity fields.", "Review inline snapshots for a descriptor and confirm only `namespace` and `codeValue` appear in key schemas." ], - "completed": false + "completed": true }, { "category": "openapi-generation", From 6a9c566f3c7a61bdcf3a32dcc5b556bc124bae74 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 13:08:33 -0500 Subject: [PATCH 06/28] Remove snapshot OpenAPI artifacts --- .../OpenApiSpecificationEnhancerBase.ts | 27 +++---------- .../OpenApiBaseDocumentEnhancer.test.ts | 10 +++++ .../OpenApiResourceFragmentEnhancer.test.ts | 40 +++++++++++++++++++ progress.txt | 6 +++ tasks.json | 2 +- 5 files changed, 63 insertions(+), 22 deletions(-) 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..cb9a5bbce 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts @@ -59,10 +59,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.', @@ -248,7 +244,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', @@ -517,7 +513,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 +532,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 +559,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', @@ -626,7 +611,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 +656,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', 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 a3ed6eec8..1652e8b25 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 @@ -60,6 +60,10 @@ 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([]); }); @@ -76,6 +80,10 @@ 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([]); }); @@ -137,6 +145,7 @@ describe('OpenApiBaseDocumentEnhancer', () => { 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([]); @@ -158,6 +167,7 @@ describe('OpenApiBaseDocumentEnhancer', () => { 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/OpenApiResourceFragmentEnhancer.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts index 3d305e764..86d3533cc 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 @@ -111,6 +111,26 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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 not create a descriptors fragment for domain entities', () => { @@ -159,6 +179,26 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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 not create a resources fragment for descriptors', () => { diff --git a/progress.txt b/progress.txt index 4e1cdb846..3e5cd9350 100644 --- a/progress.txt +++ b/progress.txt @@ -14,3 +14,9 @@ Key decisions: added reusable OpenApiChangeQuerySchemaBuilder; exact identityJso Files changed: OpenApiChangeQuerySchemaBuilder.ts, OpenApiResourceFragmentEnhancer.ts, IdentityJsonPathsEnhancer.ts, EntityApiSchemaData.ts, OpenApiChangeQuerySchemaBuilder.test.ts, IdentityJsonPathsEnhancer.test.ts, tasks.json, progress.txt. Verification: OpenApiChangeQuerySchemaBuilder Jest, OpenApiResourceFragmentEnhancer Jest, IdentityJsonPathsEnhancer Jest, package tsc, package ESLint. Notes: components now exist for later /deletes and /keyChanges path wiring; authoritative artifact refresh still deferred. + +2026-06-10 - Completed openapi-generation snapshot cleanup for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: removed shared NotFoundUseSnapshot response; GET-many and GET-by-id now use NotFound; GET-by-id no longer emits Use-Snapshot header; write/delete 405 descriptions are generic. +Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiBaseDocumentEnhancer.test.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. +Verification: OpenApiResourceFragmentEnhancer Jest, OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint, source search for snapshot OpenAPI strings. +Notes: checked-in integration artifacts still reflect old output and remain deferred to authoritative-artifacts task. diff --git a/tasks.json b/tasks.json index ac9b23f70..a86387c78 100644 --- a/tasks.json +++ b/tasks.json @@ -50,7 +50,7 @@ "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", "Search generated ApiSchema artifacts with `rg \"Use-Snapshot|NotFoundUseSnapshot|snapshot\" packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm remaining matches are outside DMS OpenAPI output or are intentionally unrelated model text." ], - "completed": false + "completed": true }, { "category": "semantic-modeling", From afe38742deefc4b16da1da737e1be2dc455fc7c2 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 13:13:28 -0500 Subject: [PATCH 07/28] Cover live Change Query filters --- .../OpenApiBaseDocumentEnhancer.test.ts | 18 ++ .../OpenApiResourceFragmentEnhancer.test.ts | 173 +++++++++++++++++- progress.txt | 6 + tasks.json | 2 +- 4 files changed, 197 insertions(+), 2 deletions(-) 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 1652e8b25..3d35ee5cb 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 @@ -158,6 +158,24 @@ describe('OpenApiBaseDocumentEnhancer', () => { 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: { + type: 'integer', + format: 'int64', + }, + }); + expect(resourcesDoc?.components?.parameters?.MaxChangeVersion).toEqual({ + name: 'maxChangeVersion', + in: 'query', + description: 'Used in synchronization to set sequence maximum ChangeVersion', + schema: { + type: 'integer', + format: 'int64', + }, + }); }); it('should include hardcoded responses', () => { 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 86d3533cc..a84f0ffc3 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 @@ -7,12 +7,13 @@ import { DomainEntityBuilder, DomainEntityExtensionBuilder, DescriptorBuilder, - MetaEdEnvironment, + EnumerationBuilder, MetaEdTextBuilder, NamespaceBuilder, newMetaEdEnvironment, newPluginEnvironment, } from '@edfi/metaed-core'; +import type { MetaEdEnvironment, Namespace, SchoolYearEnumeration, TopLevelEntity } from '@edfi/metaed-core'; import { domainEntityReferenceEnhancer, descriptorReferenceEnhancer, @@ -40,6 +41,49 @@ import { enhance as typeCoercionJsonPathsEnhancer } from '../../src/enhancer/Typ import { enhance } from '../../src/enhancer/OpenApiResourceFragmentEnhancer'; import { NamespaceEdfiApiSchema } from '../../src/model/Namespace'; import { OpenApiDocumentType } from '../../src/model/api-schema/OpenApiDocumentType'; +import type { OpenApiFragment } from '../../src/model/api-schema/OpenApiFragment'; +import type { Operation, Parameter } from '../../src/model/OpenApiTypes'; + +/** + * OpenAPI operation methods generated by the resource fragment enhancer. + */ +type OpenApiOperationMethod = 'get' | 'post' | 'put' | 'delete'; + +const changeVersionParameterRefs: string[] = [ + '#/components/parameters/MinChangeVersion', + '#/components/parameters/MaxChangeVersion', +]; + +/** + * 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] : [])); +} + +/** + * 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)); +} function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment) { namespaceSetupEnhancer(metaEd); @@ -133,6 +177,18 @@ describe('OpenApiResourceFragmentEnhancer', () => { }); }); + 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 not create a descriptors fragment for domain entities', () => { const student = namespace.entity.domainEntity.get('Student'); const studentApiData = student.data.edfiApiSchema; @@ -201,6 +257,18 @@ describe('OpenApiResourceFragmentEnhancer', () => { }); }); + 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 not create a resources fragment for descriptors', () => { const descriptor = namespace.entity.descriptor.get('GradeLevel'); const descriptorApiData = descriptor.data.edfiApiSchema; @@ -210,6 +278,38 @@ 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')); + }); + }); + describe('when enhancing an abstract domain entity', () => { const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); @@ -356,6 +456,77 @@ 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 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'), + ); + }); }); describe('when testing projectEndpointName transformation', () => { diff --git a/progress.txt b/progress.txt index 3e5cd9350..9a54bb64a 100644 --- a/progress.txt +++ b/progress.txt @@ -20,3 +20,9 @@ Key decisions: removed shared NotFoundUseSnapshot response; GET-many and GET-by- Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiBaseDocumentEnhancer.test.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. Verification: OpenApiResourceFragmentEnhancer Jest, OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint, source search for snapshot OpenAPI strings. Notes: checked-in integration artifacts still reflect old output and remain deferred to authoritative-artifacts task. + +2026-06-10 - Completed openapi-generation live Change Query filters for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: existing shared GET-many parameter builder already emits MinChangeVersion/MaxChangeVersion with int64 component definitions; completed task by adding focused fragment coverage for core resource, descriptor, SchoolYearType, extension-defined resource/descriptor, and resource-extension overlay exclusion. +Files changed: OpenApiResourceFragmentEnhancer.test.ts, OpenApiBaseDocumentEnhancer.test.ts, tasks.json, progress.txt. +Verification: OpenApiResourceFragmentEnhancer Jest, OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint. +Notes: no source behavior change and no artifact refresh; checked-in artifacts already contained live GET-many change-version refs. diff --git a/tasks.json b/tasks.json index a86387c78..5fcb73c68 100644 --- a/tasks.json +++ b/tasks.json @@ -91,7 +91,7 @@ "Inspect generated resource and descriptor OpenAPI fragments for a core resource, descriptor, `SchoolYearType`, and extension-defined resource.", "Search generated ApiSchema artifacts with `rg \"minChangeVersion|maxChangeVersion|Use-Snapshot\" packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm change-version parameters appear only on expected operations and `Use-Snapshot` is absent from DMS OpenAPI output." ], - "completed": false + "completed": true }, { "category": "openapi-generation", From ac8bc938c5ad103bef07bbafb31ae7cac5e9f98d Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 13:19:04 -0500 Subject: [PATCH 08/28] Add Change Query tracked-change OpenAPI paths --- .../OpenApiSpecificationEnhancerBase.ts | 109 ++++++++++- .../OpenApiResourceFragmentEnhancer.test.ts | 184 ++++++++++++++++++ progress.txt | 6 + tasks.json | 2 +- 4 files changed, 298 insertions(+), 3 deletions(-) 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 cb9a5bbce..43f0f807b 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts @@ -21,6 +21,7 @@ import { import { pluralize, deAcronym, createUriSegment } from '../Utility'; import { ProjectEndpointName } from '../model/api-schema/ProjectEndpointName'; import { normalizeDescriptorName } from '../Utility'; +import { type TrackedChangeSchemaNames, trackedChangeSchemaNamesFor } from './OpenApiChangeQuerySchemaBuilder'; /** * Creates the set of hardcoded component parameters @@ -318,6 +319,29 @@ function newStaticUpdateByIdParameters(): Parameter[] { ]; } +/** + * Returns the hardcoded query parameters for Change Query tracked-change paths. + */ +function newStaticTrackedChangeQueryParameters(): Parameter[] { + return [ + { + $ref: '#/components/parameters/MinChangeVersion', + }, + { + $ref: '#/components/parameters/MaxChangeVersion', + }, + { + $ref: '#/components/parameters/limit', + }, + { + $ref: '#/components/parameters/offset', + }, + { + $ref: '#/components/parameters/totalCount', + }, + ]; +} + /** * Returns an OpenAPI schema object corresponding to the given property based on its type. */ @@ -570,6 +594,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 */ @@ -720,15 +814,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/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts index a84f0ffc3..1e8d12d6b 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,6 +6,7 @@ import { DomainEntityBuilder, DomainEntityExtensionBuilder, + DomainEntitySubclassBuilder, DescriptorBuilder, EnumerationBuilder, MetaEdTextBuilder, @@ -18,6 +19,7 @@ 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'; @@ -54,6 +56,16 @@ const changeVersionParameterRefs: string[] = [ '#/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. */ @@ -70,6 +82,13 @@ 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. */ @@ -85,6 +104,44 @@ function expectNoLiveChangeVersionFilterParameters(operation: Operation): void { 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) { namespaceSetupEnhancer(metaEd); entityPropertyApiSchemaDataSetupEnhancer(metaEd); @@ -152,6 +209,8 @@ 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'); @@ -189,6 +248,23 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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 not create a descriptors fragment for domain entities', () => { const student = namespace.entity.domainEntity.get('Student'); const studentApiData = student.data.edfiApiSchema; @@ -232,6 +308,8 @@ 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'); @@ -269,6 +347,21 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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', () => { const descriptor = namespace.entity.descriptor.get('GradeLevel'); const descriptorApiData = descriptor.data.edfiApiSchema; @@ -308,6 +401,21 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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', () => { @@ -349,6 +457,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()); @@ -518,6 +672,21 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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; + + expectTrackedChangeOperation( + operationFrom(fragment, '/sample-extension/busRoutes/deletes', 'get'), + 'SampleExtension_BusRoute_TrackedChangeDelete', + ); + expectTrackedChangeOperation( + operationFrom(fragment, '/sample-extension/busRoutes/keyChanges', 'get'), + 'SampleExtension_BusRoute_TrackedChangeKeyChange', + ); + }); + 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; @@ -527,6 +696,21 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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/progress.txt b/progress.txt index 9a54bb64a..ac2bf73c5 100644 --- a/progress.txt +++ b/progress.txt @@ -26,3 +26,9 @@ Key decisions: existing shared GET-many parameter builder already emits MinChang Files changed: OpenApiResourceFragmentEnhancer.test.ts, OpenApiBaseDocumentEnhancer.test.ts, tasks.json, progress.txt. Verification: OpenApiResourceFragmentEnhancer Jest, OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint. Notes: no source behavior change and no artifact refresh; checked-in artifacts already contained live GET-many change-version refs. + +2026-06-10 - Completed openapi-generation tracked-change paths for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: createPathsFrom now emits sibling /deletes and /keyChanges GET paths for generated resources/descriptors; operations use MinChangeVersion/MaxChangeVersion/limit/offset/totalCount refs only; responses are application/json arrays referencing per-resource tracked-change schemas; resource extensions still no standalone paths. +Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. +Verification: OpenApiResourceFragmentEnhancer Jest, ApiSchemaBuildingEnhancer Jest, package tsc, package ESLint. +Notes: authoritative artifact refresh intentionally deferred to authoritative-artifacts task; compare tests expected to differ until artifacts are updated. diff --git a/tasks.json b/tasks.json index 5fcb73c68..3e4025846 100644 --- a/tasks.json +++ b/tasks.json @@ -116,7 +116,7 @@ "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/ApiSchemaBuildingEnhancer.test.ts` from the repository root if ResourceSchema copying behavior changes.", "Inspect generated core and extension ApiSchema artifacts for representative resource, descriptor, `SchoolYearType`, and resource-extension cases." ], - "completed": false + "completed": true }, { "category": "profile-integration", From 496f8cd784e1e28c11e9248436d5acddc44402f2 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 13:23:37 -0500 Subject: [PATCH 09/28] Add profile contract coverage for change queries --- .../OpenApiResourceFragmentEnhancer.test.ts | 97 +++++++++++++++++++ progress.txt | 6 ++ tasks.json | 2 +- 3 files changed, 104 insertions(+), 1 deletion(-) 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 1e8d12d6b..5c8005cbc 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 @@ -11,6 +11,7 @@ import { EnumerationBuilder, MetaEdTextBuilder, NamespaceBuilder, + type Enhancer, newMetaEdEnvironment, newPluginEnvironment, } from '@edfi/metaed-core'; @@ -35,16 +36,19 @@ import { enhance as resourceDomainEnhancer } from '../../src/enhancer/ResourceDo 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 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 { NamespaceEdfiApiSchema } from '../../src/model/Namespace'; import { OpenApiDocumentType } from '../../src/model/api-schema/OpenApiDocumentType'; 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. @@ -143,6 +147,7 @@ function expectTrackedChangeOperation(operation: Operation, trackedChangeItemSch } function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment) { + metaEdPluginEnhancers().forEach((pluginEnhancer: Enhancer) => pluginEnhancer(metaEd)); namespaceSetupEnhancer(metaEd); entityPropertyApiSchemaDataSetupEnhancer(metaEd); entityApiSchemaDataSetupEnhancer(metaEd); @@ -152,10 +157,12 @@ function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment) { apiEntityMappingEnhancer(metaEd); jsonSchemaForInsertEnhancer(metaEd); allJsonPathsMappingEnhancer(metaEd); + mergeJsonPathsMappingEnhancer(metaEd); mergeDirectiveEqualityConstraintEnhancer(metaEd); resourceNameEnhancer(metaEd); documentPathsMappingEnhancer(metaEd); identityFullnameEnhancer(metaEd); + queryFieldMappingEnhancer(metaEd); identityJsonPathsEnhancer(metaEd); typeCoercionJsonPathsEnhancer(metaEd); resourceDomainEnhancer(metaEd); @@ -265,6 +272,84 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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', () => { const student = namespace.entity.domainEntity.get('Student'); const studentApiData = student.data.edfiApiSchema; @@ -676,6 +761,9 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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'), @@ -685,6 +773,15 @@ describe('OpenApiResourceFragmentEnhancer', () => { 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', () => { diff --git a/progress.txt b/progress.txt index ac2bf73c5..911e47d84 100644 --- a/progress.txt +++ b/progress.txt @@ -32,3 +32,9 @@ Key decisions: createPathsFrom now emits sibling /deletes and /keyChanges GET pa Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. Verification: OpenApiResourceFragmentEnhancer Jest, ApiSchemaBuildingEnhancer Jest, package tsc, package ESLint. Notes: authoritative artifact refresh intentionally deferred to authoritative-artifacts task; compare tests expected to differ until artifacts are updated. + +2026-06-10 - Completed profile-integration for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: locked MetaEd side of profile contract in unit coverage; fragments keep unprofiled resource-specific tracked-change schemas/refs, key-only schemas, application/json responses, sibling /deletes and /keyChanges paths under parent collection; no /availableChangeVersions duplication in resource fragments. Test harness now runs plugin prerequisite enhancers and QueryFieldMappingEnhancer so tracked-change refs are backed by schemas. +Files changed: OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. +Verification: OpenApiResourceFragmentEnhancer Jest, package tsc, package ESLint. +Notes: no source behavior change; authoritative artifact refresh still deferred. diff --git a/tasks.json b/tasks.json index 3e4025846..9170aa1da 100644 --- a/tasks.json +++ b/tasks.json @@ -134,7 +134,7 @@ "Review generated tracked-change component names for at least one core resource and one extension resource.", "Review generated fragments and confirm `/deletes` and `/keyChanges` paths share the owning resource path prefix." ], - "completed": false + "completed": true }, { "category": "tests", From f416899283bc80d32da8a6291be71a7b7248ad00 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 13:25:21 -0500 Subject: [PATCH 10/28] Complete change query OpenAPI test coverage task --- progress.txt | 6 ++++++ tasks.json | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/progress.txt b/progress.txt index 911e47d84..fa4804202 100644 --- a/progress.txt +++ b/progress.txt @@ -38,3 +38,9 @@ Key decisions: locked MetaEd side of profile contract in unit coverage; fragment Files changed: OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. Verification: OpenApiResourceFragmentEnhancer Jest, package tsc, package ESLint. Notes: no source behavior change; authoritative artifact refresh still deferred. + +2026-06-10 - Completed tests for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: audited focused Change Query OpenAPI coverage already added across base document, resource fragment, and schema builder suites; no extra assertions needed for task contract. +Files changed: tasks.json, progress.txt. +Verification: OpenApiBaseDocumentEnhancer/OpenApiResourceFragmentEnhancer/OpenApiChangeQuerySchemaBuilder Jest, package tsc, package ESLint. +Notes: authoritative artifact refresh still next; checked-in artifacts remain intentionally stale until authoritative-artifacts task. diff --git a/tasks.json b/tasks.json index 9170aa1da..f513fd222 100644 --- a/tasks.json +++ b/tasks.json @@ -153,7 +153,7 @@ "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", "Run any new focused test file added for Change Query OpenAPI helpers with `npx jest path/to/test.ts` from the repository root." ], - "completed": false + "completed": true }, { "category": "authoritative-artifacts", From 5014423a5e19946059384b0f1d98e41a4bcbc23f Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 13:28:47 -0500 Subject: [PATCH 11/28] Update API schema authoritative artifacts for change queries --- .../v7_1/ds-5.0-api-schema-authoritative.json | 96717 +++++++++++--- .../v7_2/ds-5.1-api-schema-authoritative.json | 100399 +++++++++++--- .../v7_2/tpdm-api-schema-authoritative.json | 9352 +- .../v7_3/ds-5.2-api-schema-authoritative.json | 103496 ++++++++++++--- .../v7_3/ds-6.0-api-schema-authoritative.json | 95761 ++++++++++++- ....0-homograph-api-schema-authoritative.json | 1567 +- ...s-6.0-sample-api-schema-authoritative.json | 1743 +- .../v7_3/ds-6.1-api-schema-authoritative.json | 99219 +++++++++++++- ....1-homograph-api-schema-authoritative.json | 1567 +- ...s-6.1-sample-api-schema-authoritative.json | 1743 +- .../homograph-api-schema-authoritative.json | 1567 +- .../v7_3/sample-api-schema-authoritative.json | 1743 +- .../v7_3/tpdm-api-schema-authoritative.json | 9352 +- progress.txt | 6 + tasks.json | 2 +- 15 files changed, 444975 insertions(+), 79259 deletions(-) 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..df2018e73 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": { @@ -1124,9 +1184,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." }, @@ -1310,9 +1367,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 +1890,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 +2067,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1995,7 +2110,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +2130,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 +2283,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2315,6 @@ }, { "$ref": "#/components/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 +2341,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2174,7 +2398,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2623,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 +2800,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2558,7 +2843,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +2863,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 +2910,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +2948,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 +2967,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +2999,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 +3016,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +3356,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 +3533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3121,7 +3576,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +3596,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 +3643,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +3681,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 +3700,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +3732,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 +3749,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +4152,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 +4322,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3739,7 +4365,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +4386,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 +4433,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 +4472,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 +4491,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 +4524,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 +4541,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +4879,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 +5056,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4301,7 +5099,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +5119,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 +5166,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +5204,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 +5223,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +5255,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 +5272,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +5612,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 +5789,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4864,7 +5832,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +5852,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 +5899,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +5937,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 +5956,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +5988,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 +6005,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +6475,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 +6672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5571,7 +6715,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +6737,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 +6784,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 +6824,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 +6843,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 +6877,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 +6894,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +7245,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 +7422,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6147,7 +7465,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +7485,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 +7532,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +7570,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 +7589,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +7621,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 +7638,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +7978,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 +8155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6710,7 +8198,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +8218,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 +8265,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +8303,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 +8322,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +8354,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 +8371,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +8711,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 +8888,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7273,7 +8931,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +8951,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 +8998,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +9036,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 +9055,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +9087,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 +9104,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +9444,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 +9621,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7836,7 +9664,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +9684,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 +9731,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +9769,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 +9788,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +9820,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 +9837,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +10177,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 +10354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8399,7 +10397,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +10417,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 +10464,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +10502,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 +10521,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +10553,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 +10570,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +10910,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 +11087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8962,7 +11130,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +11150,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 +11197,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +11235,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 +11254,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +11286,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 +11303,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +11643,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 +11820,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9525,7 +11863,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +11883,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 +11930,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +11968,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 +11987,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +12019,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 +12036,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +12376,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 +12553,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10088,7 +12596,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +12616,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 +12663,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +12701,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 +12720,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +12752,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 +12769,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +13109,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 +13286,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10651,7 +13329,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +13349,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 +13396,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +13434,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 +13453,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +13485,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 +13502,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +13842,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 +14019,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11214,7 +14062,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +14082,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 +14129,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +14167,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 +14186,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +14218,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 +14235,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +14879,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", + "namespace", + "identificationCode" + ], + "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 +15098,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12115,7 +15141,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +15163,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 +15210,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 +15250,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 +15269,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 +15303,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 +15320,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +15680,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 +15857,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12700,7 +15900,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +15920,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 +15967,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +16005,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 +16024,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +16056,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 +16073,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +16413,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 +16590,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13263,7 +16633,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +16653,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 +16700,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +16738,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 +16757,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +16789,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 +16806,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +17370,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 +17572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14067,7 +17615,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +17635,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 +17682,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +17720,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 +17739,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +17771,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 +17788,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +19479,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 +19718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16041,7 +19761,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +19783,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 +19830,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 +19870,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 +19889,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 +19923,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 +19940,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +20327,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 +20504,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16653,7 +20547,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +20567,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 +20614,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +20652,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 +20671,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +20703,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 +20720,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +21060,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 +21237,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17216,7 +21280,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +21300,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 +21347,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +21385,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 +21404,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +21436,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 +21453,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +21793,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 +21970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17779,7 +22013,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +22033,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 +22080,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +22118,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 +22137,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +22169,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 +22186,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +22593,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 +22746,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18384,7 +22789,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +22810,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 +22857,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 +22896,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 +22915,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 +22948,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 +22965,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +23287,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 +23464,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18930,7 +23507,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +23527,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 +23574,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +23612,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 +23631,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +23663,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 +23680,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +24020,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 +24197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19493,7 +24240,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +24260,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 +24307,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +24345,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 +24364,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +24396,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 +24413,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +25019,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 +25197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20322,7 +25240,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +25261,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 +25308,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 +25347,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 +25366,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 +25399,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 +25416,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +25860,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", + "schoolId", + "schoolYear", + "date" + ], + "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 +26033,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20975,7 +26076,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +26097,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 +26144,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 +26183,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 +26202,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 +26235,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 +26252,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +26584,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 +26761,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21531,7 +26804,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +26824,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 +26871,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +26909,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 +26928,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +26960,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 +26977,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +27317,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 +27494,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22094,7 +27537,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +27557,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 +27604,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +27642,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 +27661,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +27693,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 +27710,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +28175,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 +28342,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22766,7 +28385,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +28406,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 +28453,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 +28492,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 +28511,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 +28544,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 +28561,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +28893,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 +29070,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23322,7 +29113,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +29133,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 +29180,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +29218,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 +29237,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +29269,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 +29286,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +30201,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 +30465,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24541,7 +30508,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +30529,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 +30576,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 +30615,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 +30634,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 +30667,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 +30684,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +31082,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 +31259,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25163,7 +31302,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +31322,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 +31369,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +31407,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 +31426,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +31458,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 +31475,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +31815,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 +31992,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25726,7 +32035,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +32055,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 +32102,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +32140,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 +32159,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +32191,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 +32208,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +32548,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 +32725,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26289,7 +32768,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +32788,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 +32835,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +32873,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 +32892,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +32924,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 +32941,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +33373,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 +33524,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26917,7 +33567,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +33590,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 +33637,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 +33678,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 +33697,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 +33732,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 +33749,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +34078,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 +34255,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27472,7 +34298,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +34318,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 +34365,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +34403,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 +34422,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +34454,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 +34471,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +34811,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 +34988,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28035,7 +35031,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +35051,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 +35098,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +35136,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 +35155,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +35187,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 +35204,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +35544,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 +35721,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28598,7 +35764,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +35784,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 +35831,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +35869,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 +35888,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +35920,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 +35937,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +36277,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 +36454,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29161,7 +36497,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +36517,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 +36564,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +36602,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 +36621,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +36653,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 +36670,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +37183,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 +37363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29899,7 +37406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +37428,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 +37475,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 +37515,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 +37534,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 +37568,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 +37585,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +38714,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 +39178,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31545,7 +39221,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +39242,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 +39289,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 +39328,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 +39347,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 +39380,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 +39397,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +39934,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 +40164,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32353,7 +40207,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +40228,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 +40275,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 +40314,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 +40333,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 +40366,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 +40383,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +41669,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 +42186,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34208,7 +42229,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +42250,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 +42297,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 +42336,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 +42355,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 +42388,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 +42405,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +42790,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 +42967,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34817,7 +43010,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +43030,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 +43077,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +43115,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 +43134,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +43166,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 +43183,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +43616,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 +43804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35478,7 +43847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +43869,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 +43916,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 +43956,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 +43975,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 +44009,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 +44026,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +44371,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 +44548,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36048,7 +44591,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +44611,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 +44658,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +44696,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 +44715,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +44747,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 +44764,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +46685,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 +46951,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38285,7 +46994,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +47015,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 +47062,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 +47101,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 +47120,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 +47153,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 +47170,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +47573,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 +47750,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38912,7 +47793,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +47813,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 +47860,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +47898,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 +47917,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +47949,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 +47966,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +48306,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 +48483,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39475,7 +48526,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +48546,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 +48593,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +48631,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 +48650,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +48682,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 +48699,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +49039,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 +49216,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40038,7 +49259,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +49279,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 +49326,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +49364,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 +49383,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +49415,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 +49432,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +49772,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 +49949,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40601,7 +49992,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +50012,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 +50059,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +50097,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 +50116,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +50148,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 +50165,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +50505,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 +50682,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41164,7 +50725,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +50745,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 +50792,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +50830,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 +50849,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +50881,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 +50898,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +51238,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 +51415,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41727,7 +51458,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +51478,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 +51525,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +51563,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 +51582,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +51614,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 +51631,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +51971,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 +52148,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -42290,7 +52191,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +52211,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 +52258,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +52296,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 +52315,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +52347,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 +52364,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +52704,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 +52881,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -42853,7 +52924,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +52944,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 +52991,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +53029,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 +53048,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +53080,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 +53097,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +53437,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 +53614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43416,7 +53657,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +53677,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 +53724,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +53762,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 +53781,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +53813,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 +53830,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +54514,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 +54729,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44349,7 +54772,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +54796,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 +54843,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 +54885,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 +54904,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 +54940,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 +54957,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +55320,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 +55497,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44939,7 +55540,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +55560,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 +55607,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +55645,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 +55664,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +55696,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 +55713,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +57249,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 +57640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46885,7 +57683,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +57705,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 +57752,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 +57792,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 +57811,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 +57845,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 +57862,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +59083,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 +59371,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48441,7 +59414,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +59439,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 +59486,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 +59529,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 +59548,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 +59585,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 +59602,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +60028,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 +60205,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49095,7 +60248,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +60268,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 +60315,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +60353,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 +60372,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +60404,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 +60421,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +60761,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 +60938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49658,7 +60981,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +61001,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 +61048,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +61086,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 +61105,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +61137,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 +61154,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +61811,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 +62027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50576,7 +62070,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +62091,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 +62138,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 +62177,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 +62196,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 +62229,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 +62246,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +62616,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 +62793,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51170,7 +62836,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +62856,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 +62903,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +62941,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 +62960,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +62992,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 +63009,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +63349,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 +63526,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51733,7 +63569,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +63589,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 +63636,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +63674,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 +63693,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +63725,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 +63742,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +64082,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 +64259,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52296,7 +64302,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +64322,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 +64369,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +64407,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 +64426,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +64458,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 +64475,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +64815,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 +64992,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52859,7 +65035,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +65055,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 +65102,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +65140,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 +65159,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +65191,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 +65208,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +65548,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 +65725,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53422,7 +65768,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +65788,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 +65835,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +65873,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 +65892,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +65924,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 +65941,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +66388,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 +66567,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54080,7 +66610,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +66630,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 +66677,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +66715,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 +66734,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +66766,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 +66783,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +67111,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 +67288,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54631,7 +67331,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +67351,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 +67398,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +67436,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 +67455,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +67487,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 +67504,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +67844,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 +68021,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55194,7 +68064,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +68084,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 +68131,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +68169,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 +68188,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +68220,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 +68237,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +68577,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 +68754,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55757,7 +68797,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +68817,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 +68864,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +68902,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 +68921,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +68953,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 +68970,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +69310,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 +69487,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56320,7 +69530,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +69550,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 +69597,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +69635,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 +69654,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +69686,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 +69703,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +70043,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 +70220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56883,7 +70263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +70283,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 +70330,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +70368,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 +70387,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +70419,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 +70436,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +70776,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 +70953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57446,7 +70996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +71016,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 +71063,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +71101,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 +71120,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +71152,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 +71169,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +71509,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 +71686,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58009,7 +71729,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +71749,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 +71796,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +71834,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 +71853,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +71885,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 +71902,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +72669,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 +72892,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59038,7 +72935,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +72956,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 +73003,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 +73042,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 +73061,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 +73094,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 +73111,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +73486,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 +73663,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59637,7 +73706,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +73726,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 +73773,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +73811,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 +73830,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +73862,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 +73879,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +74219,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 +74396,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60200,7 +74439,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +74459,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 +74506,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +74544,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 +74563,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +74595,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 +74612,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +75352,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 +75589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61222,7 +75632,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +75653,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 +75700,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 +75739,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 +75758,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 +75791,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 +75808,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +76841,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 +77121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62586,7 +77164,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +77185,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 +77232,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 +77271,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 +77290,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 +77323,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 +77340,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +77752,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 +77929,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63222,7 +77972,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +77992,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 +78039,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +78077,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 +78096,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +78128,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 +78145,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +78485,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 +78662,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63785,7 +78705,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +78725,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 +78772,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +78810,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 +78829,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +78861,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 +78878,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +79218,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 +79395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64348,7 +79438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +79458,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 +79505,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +79543,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 +79562,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +79594,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 +79611,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +80024,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 +80200,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64977,7 +80243,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +80264,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 +80311,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 +80350,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 +80369,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 +80402,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 +80419,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +80813,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 +80972,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65577,7 +81015,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +81036,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 +81083,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 +81122,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 +81141,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 +81174,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 +81191,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +82329,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 +82802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67240,7 +82845,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +82866,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 +82913,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 +82952,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 +82971,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 +83004,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 +83021,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +83388,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 +83529,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67795,7 +83572,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +83592,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 +83639,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +83677,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 +83696,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +83728,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 +83745,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +84069,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 +84246,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68342,7 +84289,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +84309,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 +84356,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +84394,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 +84413,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +84445,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 +84462,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +85915,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 +86090,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70021,7 +86133,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86155,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 +86202,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 +86242,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 +86261,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 +86295,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 +86312,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +86668,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 +86845,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70602,7 +86888,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86908,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 +86955,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +86993,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 +87012,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +87044,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 +87061,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +87401,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 +87578,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71165,7 +87621,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +87641,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 +87688,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +87726,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 +87745,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +87777,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 +87794,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +88134,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 +88311,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71728,7 +88354,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +88374,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 +88421,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +88459,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 +88478,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +88510,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 +88527,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +88867,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 +89044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72291,7 +89087,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +89107,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 +89154,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +89192,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 +89211,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +89243,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 +89260,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +89600,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 +89777,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72854,7 +89820,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +89840,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 +89887,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +89925,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 +89944,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +89976,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 +89993,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +90333,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 +90510,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73417,7 +90553,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +90573,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 +90620,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +90658,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 +90677,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +90709,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 +90726,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +91066,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 +91243,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73980,7 +91286,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +91306,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 +91353,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +91391,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 +91410,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +91442,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 +91459,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +91799,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 +91976,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74543,7 +92019,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +92039,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 +92086,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +92124,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 +92143,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +92175,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 +92192,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +92532,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 +92709,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75106,7 +92752,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +92772,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 +92819,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +92857,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 +92876,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +92908,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 +92925,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +93444,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 +93705,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75901,7 +93748,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +93769,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 +93816,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 +93855,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 +93874,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 +93907,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 +93924,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +94298,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 +94475,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76499,7 +94518,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +94538,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 +94585,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +94623,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 +94642,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +94674,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 +94691,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +95031,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 +95208,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77062,7 +95251,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +95271,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 +95318,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +95356,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 +95375,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +95407,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 +95424,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +95845,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 +96020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77699,7 +96063,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +96084,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 +96131,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 +96170,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 +96189,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 +96222,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 +96239,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +96582,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 +96759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78266,7 +96802,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +96822,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 +96869,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +96907,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 +96926,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +96958,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 +96975,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +97382,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 +97535,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78871,7 +97578,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +97599,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 +97646,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 +97685,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 +97704,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 +97737,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 +97754,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +98143,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 +98296,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79459,7 +98339,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +98360,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 +98407,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 +98446,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 +98465,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 +98498,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 +98515,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +98837,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 +99014,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80005,7 +99057,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +99077,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 +99124,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +99162,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 +99181,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +99213,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 +99230,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +99570,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 +99747,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80568,7 +99790,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +99810,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 +99857,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +99895,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 +99914,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +99946,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 +99963,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +100303,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 +100480,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81131,7 +100523,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +100543,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 +100590,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +100628,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 +100647,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +100679,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 +100696,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +101418,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 +101710,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82189,7 +101753,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +101775,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 +101822,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 +101862,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 +101881,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 +101915,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 +101932,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +102341,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 +102518,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82823,7 +102561,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +102581,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 +102628,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +102666,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 +102685,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +102717,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 +102734,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +103608,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": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "beginDate", + "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 +103959,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84044,7 +104002,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104024,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 +104071,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 +104111,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 +104130,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 +104164,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 +104181,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +104605,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 +104782,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84693,7 +104825,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104845,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 +104892,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +104930,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 +104949,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +104981,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 +104998,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +105500,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 +105709,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85439,7 +105752,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +105775,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 +105822,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 +105863,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 +105882,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 +105917,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 +105934,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +106292,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 +106469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86023,7 +106512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +106532,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 +106579,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +106617,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 +106636,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +106668,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 +106685,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +107971,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 +108162,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87541,7 +108205,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +108227,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 +108274,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 +108314,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 +108333,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 +108367,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 +108384,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +108747,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 +108924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88129,7 +108967,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +108987,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 +109034,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +109072,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 +109091,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +109123,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 +109140,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +109480,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 +109657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88692,7 +109700,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +109720,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 +109767,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +109805,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 +109824,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +109856,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 +109873,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +110213,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 +110390,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89255,7 +110433,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +110453,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 +110500,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +110538,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 +110557,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +110589,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 +110606,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +110946,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 +111123,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89818,7 +111166,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +111186,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 +111233,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +111271,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 +111290,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +111322,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 +111339,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +111679,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 +111856,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90381,7 +111899,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +111919,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 +111966,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +112004,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 +112023,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +112055,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 +112072,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +112412,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 +112589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90944,7 +112632,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +112652,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 +112699,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +112737,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 +112756,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +112788,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 +112805,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +113145,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 +113322,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91507,7 +113365,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +113385,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 +113432,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +113470,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 +113489,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +113521,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 +113538,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +113878,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 +114055,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92070,7 +114098,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +114118,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 +114165,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +114203,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 +114222,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +114254,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 +114271,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +114611,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 +114788,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92633,7 +114831,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +114851,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 +114898,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +114936,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 +114955,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +114987,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 +115004,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +115344,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 +115521,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93196,7 +115564,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +115584,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 +115631,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +115669,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 +115688,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +115720,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 +115737,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +116077,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 +116254,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93759,7 +116297,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +116317,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 +116364,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +116402,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 +116421,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +116453,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 +116470,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +116810,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 +116987,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94322,7 +117030,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +117050,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 +117097,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +117135,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 +117154,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +117186,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 +117203,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +117543,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 +117720,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94885,7 +117763,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +117783,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 +117830,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +117868,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 +117887,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +117919,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 +117936,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +118276,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 +118453,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95448,7 +118496,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +118516,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 +118563,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +118601,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 +118620,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +118652,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 +118669,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +119009,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 +119186,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96011,7 +119229,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +119249,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 +119296,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +119334,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 +119353,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +119385,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 +119402,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +119742,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 +119919,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96574,7 +119962,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +119982,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 +120029,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +120067,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 +120086,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +120118,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 +120135,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +120966,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 +121155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97639,7 +121198,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +121219,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 +121266,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 +121305,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 +121324,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 +121357,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 +121374,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +122364,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 +122555,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98866,7 +122598,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +122619,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 +122666,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 +122705,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 +122724,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 +122757,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 +122774,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +123872,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 +124079,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100217,7 +124122,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +124144,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 +124191,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 +124231,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 +124250,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 +124284,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 +124301,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +124669,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 +124846,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100810,7 +124889,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +124909,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 +124956,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +124994,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 +125013,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +125045,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 +125062,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +125402,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 +125579,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101373,7 +125622,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +125642,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 +125689,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +125727,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 +125746,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +125778,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 +125795,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +126135,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 +126312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101936,7 +126355,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +126375,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 +126422,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +126460,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 +126479,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +126511,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 +126528,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +126868,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 +127045,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102499,7 +127088,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +127108,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 +127155,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +127193,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 +127212,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +127244,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 +127261,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +127709,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 +127899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103175,7 +127942,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +127962,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 +128009,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +128047,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 +128066,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +128098,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 +128115,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +128461,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 +128638,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103744,7 +128681,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +128701,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 +128748,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +128786,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 +128805,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +128837,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 +128854,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +129194,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 +129371,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104307,7 +129414,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +129434,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 +129481,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +129519,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 +129538,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +129570,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 +129587,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +130545,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 +130762,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105532,7 +130805,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +130831,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 +130878,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 +130922,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 +130941,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 +130979,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 +130996,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +131373,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 +131550,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106138,7 +131593,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +131613,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 +131660,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +131698,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 +131717,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +131749,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 +131766,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +132106,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 +132283,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106701,7 +132326,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +132346,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 +132393,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +132431,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 +132450,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +132482,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 +132499,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +132839,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 +133016,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107264,7 +133059,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +133079,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 +133126,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +133164,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 +133183,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +133215,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 +133232,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +133572,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 +133749,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107827,7 +133792,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +133812,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 +133859,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +133897,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 +133916,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +133948,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 +133965,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +134500,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 +134688,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108590,7 +134731,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +134752,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 +134799,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 +134838,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 +134857,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 +134890,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 +134907,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +135345,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": [ + "asOfDate", + "accountIdentifier", + "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 +135536,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109255,7 +135579,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +135600,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 +135647,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 +135686,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 +135705,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 +135738,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 +135755,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +136188,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": [ + "asOfDate", + "accountIdentifier", + "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 +136379,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109915,7 +136422,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +136443,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 +136490,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 +136529,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 +136548,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 +136581,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 +136598,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +137077,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": [ + "asOfDate", + "accountIdentifier", + "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 +137285,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110632,7 +137328,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +137349,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 +137396,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 +137435,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 +137454,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 +137487,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 +137504,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +139428,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 +139641,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112821,7 +139684,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +139707,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 +139754,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 +139795,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 +139814,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 +139849,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 +139866,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +140250,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 +140427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113431,7 +140470,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +140490,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 +140537,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +140575,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 +140594,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +140626,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 +140643,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +141072,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": [ + "asOfDate", + "accountIdentifier", + "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 +141263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114086,7 +141306,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +141327,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 +141374,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 +141413,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 +141432,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 +141465,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 +141482,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +141961,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": [ + "asOfDate", + "accountIdentifier", + "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 +142169,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114803,7 +142212,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +142233,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 +142280,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 +142319,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 +142338,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 +142371,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 +142388,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +142739,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 +142916,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115378,7 +142959,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +142979,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 +143026,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +143064,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 +143083,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +143115,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 +143132,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +143512,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 +143673,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115964,7 +143716,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +143738,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 +143785,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 +143825,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 +143844,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 +143878,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 +143895,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +144229,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 +144406,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116523,7 +144449,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +144469,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 +144516,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +144554,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 +144573,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +144605,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 +144622,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +144962,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 +145139,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117086,7 +145182,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +145202,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 +145249,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +145287,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 +145306,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +145338,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 +145355,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +145695,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 +145872,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117649,7 +145915,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +145935,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 +145982,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +146020,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 +146039,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +146071,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 +146088,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +146428,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 +146605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118212,7 +146648,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +146668,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 +146715,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +146753,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 +146772,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +146804,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 +146821,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +147161,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 +147338,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118775,7 +147381,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +147401,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 +147448,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +147486,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 +147505,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +147537,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 +147554,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +147894,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 +148071,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119338,7 +148114,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +148134,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 +148181,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +148219,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 +148238,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +148270,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 +148287,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +148627,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 +148804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119901,7 +148847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +148867,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 +148914,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +148952,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 +148971,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +149003,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 +149020,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +149360,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 +149537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120464,7 +149580,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +149600,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 +149647,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +149685,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 +149704,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +149736,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 +149753,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +150093,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 +150270,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121027,7 +150313,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +150333,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 +150380,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +150418,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 +150437,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +150469,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 +150486,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +150893,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 +151046,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121632,7 +151089,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +151110,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 +151157,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 +151196,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 +151215,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 +151248,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 +151265,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +152226,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", + "namespace", + "identificationCode" + ], + "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 +152446,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122852,7 +152489,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +152511,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 +152558,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 +152598,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 +152617,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 +152651,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 +152668,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +153294,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 +153501,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123732,7 +153544,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +153565,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 +153612,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 +153651,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 +153670,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 +153703,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 +153720,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +154082,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 +154259,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124318,7 +154302,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +154322,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 +154369,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +154407,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 +154426,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +154458,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 +154475,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +154882,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 +155035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124923,7 +155078,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +155099,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 +155146,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 +155185,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 +155204,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 +155237,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 +155254,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +156708,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 +156892,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126613,7 +156935,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +156955,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 +157108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +157140,6 @@ }, { "$ref": "#/components/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 +157166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126792,7 +157223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +157469,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 +157646,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127197,7 +157689,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +157709,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 +157862,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +157894,6 @@ }, { "$ref": "#/components/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 +157920,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127376,7 +157977,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +158202,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 +158379,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127760,7 +158422,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +158442,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 +158489,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +158527,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 +158546,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +158578,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 +158595,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +158935,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 +159112,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128323,7 +159155,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +159175,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 +159222,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +159260,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 +159279,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +159311,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 +159328,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +159657,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 +159800,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128840,7 +159843,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +159865,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 +160022,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160054,6 @@ }, { "$ref": "#/components/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 +160080,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129021,7 +160137,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160339,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 +160516,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129382,7 +160559,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +160579,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 +160732,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160764,6 @@ }, { "$ref": "#/components/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 +160790,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129561,7 +160847,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +161072,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 +161249,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129945,7 +161292,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +161312,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 +161359,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +161397,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 +161416,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +161448,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 +161465,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +161805,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 +161982,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130508,7 +162025,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +162045,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 +162092,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +162130,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 +162149,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +162181,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 +162198,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +162538,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 +162715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131071,7 +162758,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +162778,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 +162825,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +162863,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 +162882,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +162914,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 +162931,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +163271,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 +163448,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131634,7 +163491,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +163511,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 +163558,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +163596,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 +163615,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +163647,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 +163664,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +164004,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 +164181,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132197,7 +164224,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +164244,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 +164291,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +164329,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 +164348,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +164380,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 +164397,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +164802,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 +164970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132810,7 +165013,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +165034,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 +165081,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 +165120,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 +165139,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 +165172,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 +165189,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +165518,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 +165695,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133363,7 +165738,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +165758,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 +165805,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +165843,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 +165862,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +165894,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 +165911,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +167427,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 +167610,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135113,7 +167653,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +167675,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 +167722,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 +167762,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 +167781,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 +167815,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 +167832,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +168194,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 +168371,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135700,7 +168414,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +168434,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 +168481,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +168519,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 +168538,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +168570,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 +168587,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +168927,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 +169104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136263,7 +169147,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +169167,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 +169214,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +169252,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 +169271,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +169303,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 +169320,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +169660,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 +169837,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136826,7 +169880,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +169900,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 +169947,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +169985,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 +170004,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +170036,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 +170053,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +170393,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 +170570,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137389,7 +170613,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +170633,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 +170680,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +170718,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 +170737,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +170769,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 +170786,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +171126,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 +171303,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137952,7 +171346,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +171366,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 +171413,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +171451,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 +171470,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +171502,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 +171519,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +171859,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 +172036,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138515,7 +172079,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +172099,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 +172146,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +172184,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 +172203,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +172235,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 +172252,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +172592,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 +172769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139078,7 +172812,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +172832,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 +172879,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +172917,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 +172936,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +172968,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 +172985,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +173392,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 +173545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139683,7 +173588,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +173609,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 +173656,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 +173695,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 +173714,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 +173747,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 +173764,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +174495,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": [ + "programEvaluationElementTitle", + "programEducationOrganizationId", + "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 +174759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -140699,7 +174802,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +174823,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 +174870,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 +174909,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 +174928,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 +174961,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 +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": [ + "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 +175646,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": [ + "programEvaluationObjectiveTitle", + "programEducationOrganizationId", + "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 +175900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141642,7 +175943,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +175964,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 +176011,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 +176050,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 +176069,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 +176102,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 +176119,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +176500,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 +176677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142247,7 +176720,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +176740,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 +176787,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +176825,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 +176844,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +176876,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 +176893,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +177233,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 +177410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142810,7 +177453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +177473,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 +177520,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +177558,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 +177577,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +177609,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 +177626,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +178232,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": [ + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programEducationOrganizationId", + "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 +178462,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143671,7 +178505,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +178526,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 +178573,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 +178612,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 +178631,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 +178664,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 +178681,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +179049,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 +179226,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144263,7 +179269,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +179289,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 +179336,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +179374,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 +179393,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +179425,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 +179442,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +179782,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 +179959,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144826,7 +180002,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +180022,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 +180069,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +180107,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 +180126,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +180158,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 +180175,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +180751,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 +180919,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145610,7 +180962,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +180993,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 +181040,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 +181089,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 +181108,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 +181151,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 +181168,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +181516,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 +181693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146192,7 +181736,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +181756,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 +181803,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +181841,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 +181860,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +181892,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 +181909,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +182249,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 +182426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146755,7 +182469,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +182489,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 +182536,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +182574,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 +182593,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +182625,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 +182642,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +183049,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 +183202,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147360,7 +183245,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +183266,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 +183313,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 +183352,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 +183371,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 +183404,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 +183421,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +183743,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 +183920,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147906,7 +183963,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +183983,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 +184030,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +184068,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 +184087,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +184119,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 +184136,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +184476,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 +184653,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148469,7 +184696,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +184716,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 +184763,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +184801,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 +184820,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +184852,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 +184869,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +185209,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 +185386,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149032,7 +185429,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +185449,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 +185496,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +185534,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 +185553,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +185585,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 +185602,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +185942,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 +186119,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149595,7 +186162,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +186182,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 +186229,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +186267,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 +186286,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +186318,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 +186335,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +186675,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 +186852,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150158,7 +186895,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +186915,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 +186962,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +187000,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 +187019,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +187051,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 +187068,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +187408,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 +187585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150721,7 +187628,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +187648,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 +187695,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +187733,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 +187752,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +187784,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 +187801,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +188141,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 +188318,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151284,7 +188361,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +188381,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 +188428,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +188466,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 +188485,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +188517,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 +188534,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +188874,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 +189051,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151847,7 +189094,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +189114,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 +189161,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +189199,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 +189218,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +189250,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 +189267,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +189607,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 +189784,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152410,7 +189827,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +189847,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 +189894,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +189932,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 +189951,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +189983,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 +190000,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +190340,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 +190517,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152973,7 +190560,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +190580,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 +190627,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +190665,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 +190684,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +190716,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 +190733,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +191073,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 +191250,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153536,7 +191293,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +191313,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 +191360,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +191398,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 +191417,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +191449,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 +191466,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +191806,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 +191983,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154099,7 +192026,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +192046,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 +192093,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +192131,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 +192150,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +192182,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 +192199,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +193231,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 +193463,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155387,7 +193506,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +193528,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 +193575,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 +193615,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 +193634,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 +193668,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 +193685,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +194054,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 +194231,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155981,7 +194274,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +194294,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 +194341,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +194379,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 +194398,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +194430,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 +194447,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +194787,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 +194964,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156544,7 +195007,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +195027,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 +195074,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +195112,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 +195131,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +195163,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 +195180,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +195520,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 +195697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157107,7 +195740,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +195760,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 +195807,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +195845,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 +195864,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +195896,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 +195913,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +196253,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 +196430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157670,7 +196473,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +196493,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 +196540,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +196578,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 +196597,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +196629,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 +196646,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +196986,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 +197163,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158233,7 +197206,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +197226,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 +197273,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +197311,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 +197330,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +197362,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 +197379,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +197719,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 +197896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158796,7 +197939,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +197959,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 +198006,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +198044,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 +198063,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +198095,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 +198112,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +198682,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 +198860,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159583,7 +198903,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +198924,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 +198971,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 +199010,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 +199029,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 +199062,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 +199079,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +199423,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 +199600,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160151,7 +199643,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +199663,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 +199710,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +199748,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 +199767,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +199799,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 +199816,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +200156,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 +200333,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160714,7 +200376,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +200396,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 +200443,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +200481,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 +200500,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +200532,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 +200549,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +200889,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 +201066,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161277,7 +201109,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +201129,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 +201176,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +201214,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 +201233,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +201265,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 +201282,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +201622,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 +201799,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161840,7 +201842,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +201862,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 +201909,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +201947,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 +201966,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +201998,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 +202015,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +202355,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 +202532,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162403,7 +202575,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +202595,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 +202642,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +202680,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 +202699,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +202731,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 +202748,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +203088,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 +203265,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162966,7 +203308,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +203328,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 +203375,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +203413,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 +203432,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +203464,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 +203481,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +203821,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 +203998,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163529,7 +204041,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +204061,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 +204108,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +204146,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 +204165,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +204197,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 +204214,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +204523,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 +204664,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164030,7 +204707,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +204727,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 +204880,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +204912,6 @@ }, { "$ref": "#/components/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 +204938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164209,7 +204995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +206620,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 +206867,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166068,7 +206910,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +206944,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 +207125,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +207157,6 @@ }, { "$ref": "#/components/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 +207183,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166261,7 +207240,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +207757,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 +208001,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166975,7 +208044,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +208065,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 +208112,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 +208151,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 +208170,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 +208203,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 +208220,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +208586,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 +208763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167565,7 +208806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +208826,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 +208873,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +208911,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 +208930,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +208962,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 +208979,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +209319,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 +209496,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168128,7 +209539,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +209559,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 +209606,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +209644,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 +209663,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +209695,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 +209712,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +210784,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", + "sessionName", + "sectionIdentifier" + ], + "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 +211096,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169540,7 +211139,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +211171,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 +211218,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 +211268,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 +211287,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 +211331,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 +211348,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +211783,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 +211960,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170210,7 +212003,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +212023,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 +212070,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +212108,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 +212127,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +212159,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 +212176,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +212516,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 +212693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170773,7 +212736,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +212756,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 +212803,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +212841,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 +212860,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +212892,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 +212909,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +213249,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 +213426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171336,7 +213469,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +213489,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 +213536,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +213574,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 +213593,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +213625,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 +213642,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +214308,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 +214502,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172236,7 +214545,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +214572,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 +214619,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 +214664,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 +214683,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 +214722,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 +214739,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +215096,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 +215273,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172823,7 +215316,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +215336,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 +215383,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +215421,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 +215440,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +215472,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 +215489,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +215896,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 +216049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173428,7 +216092,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +216113,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 +216160,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 +216199,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 +216218,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 +216251,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 +216268,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +216590,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 +216767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173974,7 +216810,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +216830,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 +216877,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +216915,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 +216934,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +216966,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 +216983,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +217323,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 +217500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174537,7 +217543,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +217563,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 +217610,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +217648,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 +217667,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +217699,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 +217716,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +218056,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 +218233,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175100,7 +218276,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +218296,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 +218343,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +218381,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 +218400,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +218432,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 +218449,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +218789,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 +218966,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175663,7 +219009,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +219029,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 +219076,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +219114,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 +219133,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +219165,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 +219182,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +219596,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 +219773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176294,7 +219816,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +219837,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 +219884,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 +219923,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 +219942,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 +219975,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 +219992,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +220327,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 +220504,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176853,7 +220547,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +220567,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 +220614,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +220652,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 +220671,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +220703,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 +220720,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +221162,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 +221354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177521,7 +221397,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +221418,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 +221465,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 +221504,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 +221523,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 +221556,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 +221573,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +222011,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 +222171,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178159,7 +222214,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +222234,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 +222281,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +222319,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 +222338,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +222370,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 +222387,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +222990,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 +223251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179058,7 +223294,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +223315,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 +223362,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 +223401,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 +223420,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 +223453,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 +223470,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +224464,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 +224643,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180271,7 +224686,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +224707,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 +224754,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 +224793,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 +224812,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 +224845,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 +224862,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +225492,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 +225759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181204,7 +225802,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +225823,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 +225870,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 +225909,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 +225928,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 +225961,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 +225978,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +226371,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 +226548,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181821,7 +226591,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +226611,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 +226658,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +226696,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 +226715,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +226747,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 +226764,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +227104,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 +227281,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182384,7 +227324,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +227344,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 +227391,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +227429,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 +227448,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +227480,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 +227497,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +227924,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 +228109,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183036,7 +228152,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +228173,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 +228220,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 +228259,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 +228278,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 +228311,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 +228328,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +228793,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 +229000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183738,7 +229043,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +229067,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 +229114,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 +229156,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 +229175,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 +229211,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 +229228,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +229844,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 +230022,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184576,7 +230065,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +230088,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 +230135,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 +230176,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 +230195,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 +230230,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 +230247,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +230822,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 +231089,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185438,7 +231132,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +231156,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 +231203,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 +231245,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 +231264,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 +231300,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 +231317,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +234248,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 +234578,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188753,7 +234621,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +234651,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 +234698,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 +234746,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 +234765,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 +234807,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 +234824,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +235273,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 +235450,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189435,7 +235493,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +235513,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 +235560,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +235598,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 +235617,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +235649,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 +235666,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +237247,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 +237412,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191232,7 +237455,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +237477,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 +237524,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 +237564,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 +237583,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 +237617,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 +237634,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +239638,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 +239928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193563,7 +239971,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +239994,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 +240041,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 +240082,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 +240101,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 +240136,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 +240153,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +240712,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": [ + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "assessmentIdentifier", + "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 +240930,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194365,7 +240973,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +240993,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 +241040,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +241078,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 +241097,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +241129,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 +241146,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +242792,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 +243110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196361,7 +243153,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +243175,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 +243222,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 +243262,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 +243281,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 +243315,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 +243332,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +244250,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 +244506,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197561,7 +244549,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +244569,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 +244616,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +244654,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 +244673,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +244705,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 +244722,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +245110,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 +245287,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198172,7 +245330,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +245350,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 +245397,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +245435,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 +245454,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +245486,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 +245503,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +246044,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 +246228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198931,7 +246271,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +246293,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 +246340,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 +246380,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 +246399,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 +246433,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 +246450,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +247252,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", + "objectiveEducationOrganizationId", + "objective", + "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 +247508,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200004,7 +247551,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +247573,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 +247620,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 +247660,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 +247679,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 +247713,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 +247730,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +248248,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 +248453,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200773,7 +248496,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +248517,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 +248564,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 +248603,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 +248622,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 +248655,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 +248672,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +249174,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 +249359,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201495,7 +249402,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +249422,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 +249469,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +249507,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 +249526,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +249558,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 +249575,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +250004,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 +250164,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202123,7 +250207,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +250227,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 +250274,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +250312,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 +250331,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +250363,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 +250380,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +252841,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 +253122,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204910,7 +253165,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +253187,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 +253234,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 +253274,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 +253293,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 +253327,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 +253344,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +253845,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 +254027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205630,7 +254070,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +254091,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 +254138,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 +254177,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 +254196,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 +254229,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 +254246,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +254811,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 +255055,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206478,7 +255098,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +255120,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 +255167,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 +255207,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 +255226,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 +255260,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 +255277,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +256121,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 +256377,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207604,7 +256420,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +256440,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 +256487,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +256525,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 +256544,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +256576,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 +256593,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +256981,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 +257158,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208215,7 +257201,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +257221,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 +257268,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +257306,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 +257325,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +257357,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 +257374,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +257980,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 +258180,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209060,7 +258223,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +258245,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 +258292,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 +258332,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 +258351,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 +258385,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 +258402,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +258943,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", + "eventDate", + "educationOrganizationId", + "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 +259170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209859,7 +259213,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +259234,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 +259281,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 +259320,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 +259339,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 +259372,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 +259389,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +260351,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 +260599,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211094,7 +260642,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +260662,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 +260709,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +260747,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 +260766,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +260798,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 +260815,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +261780,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 +262091,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212394,7 +262134,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +262154,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 +262201,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +262239,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 +262258,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +262290,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 +262307,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +263204,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 +263462,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213573,7 +263505,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +263525,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 +263572,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +263610,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 +263629,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +263661,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 +263678,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +264066,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 +264243,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214184,7 +264286,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +264306,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 +264353,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +264391,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 +264410,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +264442,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 +264459,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +265216,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 +265447,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215196,7 +265490,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +265517,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 +265564,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 +265609,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 +265628,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 +265667,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 +265684,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +266310,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 +266567,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216105,7 +266610,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +266633,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 +266680,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 +266721,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 +266740,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 +266775,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 +266792,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +267947,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 +268240,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217570,7 +268283,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +268304,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 +268351,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 +268390,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 +268409,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 +268442,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 +268459,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +269589,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 +269954,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219106,7 +269997,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +270022,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 +270069,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 +270112,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 +270131,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 +270168,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 +270185,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +270948,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 +271206,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220156,7 +271249,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +271272,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 +271319,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 +271360,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 +271379,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 +271414,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 +271431,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +272245,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 +272484,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221236,7 +272527,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +272547,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 +272594,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +272632,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 +272651,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +272683,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 +272700,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +273399,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 +273666,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222219,7 +273709,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +273738,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 +273785,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 +273832,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 +273851,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 +273892,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 +273909,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +274668,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 +274960,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223291,7 +275003,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +275026,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 +275185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +275217,6 @@ }, { "$ref": "#/components/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 +275243,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223473,7 +275300,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +276575,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 +276920,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225053,7 +276963,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +276984,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 +277139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +277171,6 @@ }, { "$ref": "#/components/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 +277197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225233,7 +277254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +278005,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 +278329,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226273,7 +278372,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +278392,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 +278545,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +278577,6 @@ }, { "$ref": "#/components/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 +278603,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226452,7 +278660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +279409,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 +279649,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227401,7 +279692,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +279712,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 +279865,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +279897,6 @@ }, { "$ref": "#/components/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 +279923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227580,7 +279980,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +281162,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 +281473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229059,7 +281516,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +281554,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 +281743,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +281775,6 @@ }, { "$ref": "#/components/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 +281801,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229256,7 +281858,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +282193,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 +282370,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229750,7 +282413,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +282433,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 +282586,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +282618,6 @@ }, { "$ref": "#/components/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 +282644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229929,7 +282701,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +282926,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 +283103,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230313,7 +283146,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +283166,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 +283319,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +283351,6 @@ }, { "$ref": "#/components/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 +283377,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230492,7 +283434,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +283659,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 +283836,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230876,7 +283879,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +283899,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 +284052,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +284084,6 @@ }, { "$ref": "#/components/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 +284110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231055,7 +284167,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +284451,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 +284628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231485,7 +284671,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +284692,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 +284847,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +284879,6 @@ }, { "$ref": "#/components/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 +284905,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231665,7 +284962,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +285180,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 +285357,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232042,7 +285400,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +285420,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 +285573,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +285605,6 @@ }, { "$ref": "#/components/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 +285631,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232221,7 +285688,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +285991,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", + "programName", + "programTypeDescriptor", + "namespace", + "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 +286183,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232680,7 +286226,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +286247,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 +286402,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +286434,6 @@ }, { "$ref": "#/components/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 +286460,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232860,7 +286517,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287124,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 +287321,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233632,7 +287364,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +287385,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 +287540,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287572,6 @@ }, { "$ref": "#/components/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 +287598,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233812,7 +287655,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288214,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": [ + "questionCode", + "namespace", + "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 +288406,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234537,7 +288449,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +288470,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 +288625,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288657,6 @@ }, { "$ref": "#/components/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 +288683,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234717,7 +288740,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289026,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 +289203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235149,7 +289246,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +289267,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 +289422,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289454,6 @@ }, { "$ref": "#/components/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 +289480,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235329,7 +289537,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289816,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": [ + "staffUniqueId", + "namespace", + "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 +289995,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235755,7 +290038,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +290059,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 +290214,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +290246,6 @@ }, { "$ref": "#/components/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 +290272,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235935,7 +290329,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +290814,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 +291056,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236636,7 +291099,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +291120,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 +291275,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +291307,6 @@ }, { "$ref": "#/components/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 +291333,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236816,7 +291390,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +291772,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", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "namespace", + "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 +291998,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237376,7 +292041,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +292062,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 +292217,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +292249,6 @@ }, { "$ref": "#/components/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 +292275,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237556,7 +292332,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +292659,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 +292853,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238040,7 +292896,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +292917,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 +293072,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293104,6 @@ }, { "$ref": "#/components/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 +293130,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238220,7 +293187,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293504,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": [ + "staffUniqueId", + "namespace", + "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 +293700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238695,7 +293743,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +293764,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 +293919,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293951,6 @@ }, { "$ref": "#/components/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 +293977,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238875,7 +294034,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294375,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": [ + "surveyResponseIdentifier", + "namespace", + "surveyIdentifier", + "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 +294563,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239372,7 +294606,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +294627,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 +294782,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294814,6 @@ }, { "$ref": "#/components/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 +294840,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239552,7 +294897,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295143,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 +295305,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239934,7 +295348,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +295369,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 +295524,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295556,6 @@ }, { "$ref": "#/components/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 +295582,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240114,7 +295639,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296032,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 +296245,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240700,7 +296288,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +296309,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 +296464,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296496,6 @@ }, { "$ref": "#/components/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 +296522,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240880,7 +296579,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296823,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 +297000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241283,7 +297043,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +297063,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 +297216,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297248,6 @@ }, { "$ref": "#/components/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 +297274,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241462,7 +297331,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297556,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 +297733,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241846,7 +297776,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +297796,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 +297949,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297981,6 @@ }, { "$ref": "#/components/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 +298007,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242025,7 +298064,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298289,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 +298466,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242409,7 +298509,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +298529,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 +298682,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298714,6 @@ }, { "$ref": "#/components/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 +298740,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242588,7 +298797,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299022,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 +299199,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242972,7 +299242,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +299262,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 +299415,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299447,6 @@ }, { "$ref": "#/components/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 +299473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243151,7 +299530,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299755,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 +299932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243535,7 +299975,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +299995,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 +300148,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300180,6 @@ }, { "$ref": "#/components/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 +300206,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243714,7 +300263,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300488,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 +300665,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244098,7 +300708,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +300728,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 +300881,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300913,6 @@ }, { "$ref": "#/components/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 +300939,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244277,7 +300996,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301221,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 +301398,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244661,7 +301441,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +301461,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 +301614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301646,6 @@ }, { "$ref": "#/components/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 +301672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244840,7 +301729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301954,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 +302131,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245224,7 +302174,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +302194,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 +302347,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302379,6 @@ }, { "$ref": "#/components/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 +302405,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245403,7 +302462,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302687,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 +302864,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245787,7 +302907,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +302927,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 +303080,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303112,6 @@ }, { "$ref": "#/components/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 +303138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245966,7 +303195,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303420,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 +303597,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246350,7 +303640,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +303660,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 +303813,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303845,6 @@ }, { "$ref": "#/components/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 +303871,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246529,7 +303928,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304153,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 +304330,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246913,7 +304373,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +304393,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 +304546,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304578,6 @@ }, { "$ref": "#/components/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 +304604,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247092,7 +304661,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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..b1b044498 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": { @@ -1114,9 +1174,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." }, @@ -1300,9 +1357,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 +1892,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 +2069,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1997,7 +2112,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +2132,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 +2285,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2317,6 @@ }, { "$ref": "#/components/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 +2343,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2176,7 +2400,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2625,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 +2802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2560,7 +2845,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +2865,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 +2912,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +2950,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 +2969,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +3001,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 +3018,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +3358,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 +3535,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3123,7 +3578,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +3598,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 +3645,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +3683,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 +3702,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +3734,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 +3751,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +4154,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 +4324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3741,7 +4367,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +4388,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 +4435,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 +4474,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 +4493,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 +4526,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 +4543,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +4881,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 +5058,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4303,7 +5101,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +5121,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 +5168,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +5206,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 +5225,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +5257,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 +5274,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +5614,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 +5791,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4866,7 +5834,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +5854,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 +5901,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +5939,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 +5958,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +5990,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 +6007,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +6468,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 +6660,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5560,7 +6703,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +6725,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 +6772,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 +6812,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 +6831,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 +6865,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 +6882,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +7233,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 +7410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6136,7 +7453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +7473,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 +7520,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +7558,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 +7577,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +7609,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 +7626,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +7966,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 +8143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6699,7 +8186,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +8206,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 +8253,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +8291,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 +8310,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +8342,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 +8359,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +8699,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 +8876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7262,7 +8919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +8939,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 +8986,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +9024,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 +9043,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +9075,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 +9092,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +9432,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 +9609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7825,7 +9652,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +9672,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 +9719,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +9757,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 +9776,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +9808,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 +9825,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +10165,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 +10342,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8388,7 +10385,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +10405,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 +10452,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +10490,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 +10509,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +10541,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 +10558,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +10898,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 +11075,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8951,7 +11118,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +11138,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 +11185,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +11223,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 +11242,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +11274,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 +11291,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +11631,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 +11808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9514,7 +11851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +11871,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 +11918,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +11956,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 +11975,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +12007,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 +12024,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +12364,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 +12541,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10077,7 +12584,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +12604,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 +12651,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +12689,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 +12708,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +12740,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 +12757,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +13097,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 +13274,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10640,7 +13317,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +13337,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 +13384,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +13422,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 +13441,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +13473,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 +13490,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +13830,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 +14007,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11203,7 +14050,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +14070,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 +14117,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +14155,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 +14174,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +14206,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 +14223,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +14853,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", + "namespace", + "identificationCode" + ], + "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 +15066,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12086,7 +15109,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +15131,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 +15178,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 +15218,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 +15237,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 +15271,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 +15288,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +15648,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 +15825,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12671,7 +15868,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +15888,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 +15935,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +15973,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 +15992,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +16024,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 +16041,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +16381,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 +16558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13234,7 +16601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +16621,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 +16668,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +16706,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 +16725,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +16757,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 +16774,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +17326,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 +17521,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14021,7 +17564,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +17584,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 +17631,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +17669,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 +17688,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +17720,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 +17737,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +19393,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 +19626,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15955,7 +19669,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +19691,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 +19738,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 +19778,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 +19797,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 +19831,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 +19848,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +20235,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 +20412,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16567,7 +20455,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +20475,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 +20522,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +20560,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 +20579,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +20611,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 +20628,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +20968,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 +21145,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17130,7 +21188,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +21208,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 +21255,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +21293,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 +21312,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +21344,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 +21361,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +21701,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 +21878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17693,7 +21921,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +21941,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 +21988,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +22026,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 +22045,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +22077,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 +22094,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +22496,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 +22646,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18291,7 +22689,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +22710,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 +22757,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 +22796,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 +22815,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 +22848,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 +22865,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +23187,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 +23364,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18837,7 +23407,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +23427,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 +23474,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +23512,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 +23531,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +23563,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 +23580,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +23920,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 +24097,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19400,7 +24140,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +24160,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 +24207,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +24245,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 +24264,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +24296,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 +24313,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +24913,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 +25088,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20221,7 +25131,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +25152,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 +25199,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 +25238,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 +25257,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 +25290,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 +25307,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +25651,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 +25828,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20789,7 +25871,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +25891,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 +25938,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +25976,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 +25995,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +26027,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 +26044,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +26482,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", + "schoolId", + "schoolYear", + "date" + ], + "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 +26653,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21434,7 +26696,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +26717,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 +26764,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 +26803,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 +26822,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 +26855,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 +26872,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +27204,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 +27381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21990,7 +27424,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +27444,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 +27491,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +27529,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 +27548,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +27580,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 +27597,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +27937,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 +28114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22553,7 +28157,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +28177,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 +28224,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +28262,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 +28281,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +28313,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 +28330,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +28792,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 +28957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23221,7 +29000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +29021,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 +29068,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 +29107,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 +29126,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 +29159,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 +29176,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +29508,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 +29685,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23777,7 +29728,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +29748,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 +29795,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +29833,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 +29852,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +29884,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 +29901,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +30803,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 +31057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24974,7 +31100,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +31121,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 +31168,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 +31207,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 +31226,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 +31259,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 +31276,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +31674,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 +31851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25596,7 +31894,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +31914,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 +31961,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +31999,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 +32018,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +32050,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 +32067,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +32407,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 +32584,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26159,7 +32627,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +32647,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 +32694,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +32732,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 +32751,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +32783,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 +32800,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +33140,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 +33317,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26722,7 +33360,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +33380,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 +33427,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +33465,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 +33484,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +33516,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 +33533,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +33962,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 +34111,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27346,7 +34154,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +34177,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 +34224,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 +34265,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 +34284,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 +34319,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 +34336,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +34665,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 +34842,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27901,7 +34885,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +34905,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 +34952,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +34990,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 +35009,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +35041,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 +35058,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +35398,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 +35575,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28464,7 +35618,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +35638,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 +35685,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +35723,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 +35742,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +35774,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 +35791,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +36131,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 +36308,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29027,7 +36351,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +36371,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 +36418,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +36456,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 +36475,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +36507,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 +36524,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +36864,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 +37041,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29590,7 +37084,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +37104,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 +37151,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +37189,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 +37208,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +37240,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 +37257,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +37764,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 +37941,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30320,7 +37984,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +38006,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 +38053,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 +38093,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 +38112,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 +38146,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 +38163,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +39270,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 +39714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31924,7 +39757,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +39778,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 +39825,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 +39864,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 +39883,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 +39916,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 +39933,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +40467,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 +40695,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32728,7 +40738,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +40759,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 +40806,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 +40845,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 +40864,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 +40897,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 +40914,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +42178,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 +42675,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34541,7 +42718,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +42739,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 +42786,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 +42825,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 +42844,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 +42877,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 +42894,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +43279,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 +43456,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35150,7 +43499,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +43519,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 +43566,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +43604,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 +43623,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +43655,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 +43672,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +44096,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 +44279,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35798,7 +44322,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +44344,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 +44391,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 +44431,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 +44450,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 +44484,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 +44501,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +44846,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 +45023,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36368,7 +45066,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +45086,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 +45133,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +45171,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 +45190,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +45222,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 +45239,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +47092,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 +47346,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38526,7 +47389,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +47410,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 +47457,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 +47496,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 +47515,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 +47548,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 +47565,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +47968,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 +48145,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39153,7 +48188,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +48208,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 +48255,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +48293,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 +48312,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +48344,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 +48361,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +48701,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 +48878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39716,7 +48921,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +48941,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 +48988,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +49026,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 +49045,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +49077,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 +49094,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +49434,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 +49611,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40279,7 +49654,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +49674,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 +49721,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +49759,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 +49778,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +49810,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 +49827,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +50167,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 +50344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40842,7 +50387,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +50407,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 +50454,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +50492,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 +50511,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +50543,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 +50560,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +50900,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 +51077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41405,7 +51120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +51140,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 +51187,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +51225,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 +51244,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +51276,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 +51293,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +51633,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 +51810,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41968,7 +51853,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +51873,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 +51920,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +51958,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 +51977,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +52009,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 +52026,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +52366,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 +52543,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -42531,7 +52586,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +52606,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 +52653,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +52691,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 +52710,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +52742,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 +52759,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +53099,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 +53276,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43094,7 +53319,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +53339,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 +53386,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +53424,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 +53443,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +53475,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 +53492,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +53832,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 +54009,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43657,7 +54052,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +54072,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 +54119,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +54157,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 +54176,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +54208,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 +54225,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +54901,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 +55110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44578,7 +55153,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +55177,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 +55224,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 +55266,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 +55285,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 +55321,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 +55338,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +55701,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 +55878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45168,7 +55921,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +55941,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 +55988,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +56026,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 +56045,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +56077,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 +56094,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +57603,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 +57984,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47079,7 +58027,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +58049,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 +58096,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 +58136,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 +58155,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 +58189,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 +58206,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +59415,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 +59699,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48620,7 +59742,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +59767,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 +59814,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 +59857,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 +59876,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 +59913,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 +59930,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +60356,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 +60533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49274,7 +60576,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +60596,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 +60643,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +60681,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 +60700,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +60732,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 +60749,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +61089,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 +61266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49837,7 +61309,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +61329,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 +61376,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +61414,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 +61433,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +61465,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 +61482,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +62134,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 +62348,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50749,7 +62391,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +62412,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 +62459,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 +62498,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 +62517,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 +62550,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 +62567,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +62937,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 +63114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51343,7 +63157,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +63177,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 +63224,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +63262,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 +63281,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +63313,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 +63330,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +63670,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 +63847,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51906,7 +63890,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +63910,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 +63957,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +63995,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 +64014,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +64046,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 +64063,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +64435,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 +64597,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52491,7 +64640,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +64661,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 +64708,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 +64747,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 +64766,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 +64799,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 +64816,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +65150,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 +65327,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53049,7 +65370,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +65390,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 +65437,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +65475,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 +65494,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +65526,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 +65543,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +65883,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 +66060,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53612,7 +66103,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +66123,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 +66170,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +66208,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 +66227,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +66259,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 +66276,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +66616,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 +66793,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54175,7 +66836,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +66856,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 +66903,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +66941,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 +66960,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +66992,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 +67009,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +67349,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 +67526,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54738,7 +67569,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +67589,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 +67636,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +67674,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 +67693,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +67725,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 +67742,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +68183,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 +68358,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55388,7 +68401,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +68421,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 +68468,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +68506,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 +68525,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +68557,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 +68574,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +68902,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 +69079,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55939,7 +69122,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +69142,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 +69189,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +69227,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 +69246,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +69278,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 +69295,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +69635,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 +69812,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56502,7 +69855,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +69875,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 +69922,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +69960,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 +69979,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +70011,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 +70028,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +70368,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 +70545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57065,7 +70588,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +70608,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 +70655,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +70693,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 +70712,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +70744,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 +70761,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +71101,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 +71278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57628,7 +71321,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +71341,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 +71388,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +71426,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 +71445,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +71477,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 +71494,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +71834,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 +72011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58191,7 +72054,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +72074,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 +72121,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +72159,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 +72178,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +72210,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 +72227,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +72567,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 +72744,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58754,7 +72787,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +72807,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 +72854,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +72892,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 +72911,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +72943,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 +72960,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +73300,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 +73477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59317,7 +73520,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +73540,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 +73587,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +73625,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 +73644,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +73676,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 +73693,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +74452,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 +74671,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60336,7 +74714,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +74735,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 +74782,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 +74821,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 +74840,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 +74873,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 +74890,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +75265,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 +75442,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60935,7 +75485,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +75505,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 +75552,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +75590,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 +75609,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +75641,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 +75658,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +75998,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 +76175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61498,7 +76218,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +76238,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 +76285,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +76323,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 +76342,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +76374,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 +76391,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +77116,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 +77348,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62501,7 +77391,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +77412,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 +77459,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 +77498,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 +77517,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 +77550,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 +77567,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +77946,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 +78123,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63104,7 +78166,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +78186,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 +78233,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +78271,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 +78290,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +78322,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 +78339,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +79318,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 +79591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64407,7 +79634,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +79655,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 +79702,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 +79741,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 +79760,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 +79793,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 +79810,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +80222,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 +80399,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65043,7 +80442,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +80462,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 +80509,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +80547,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 +80566,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +80598,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 +80615,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +80955,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 +81132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65606,7 +81175,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +81195,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 +81242,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +81280,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 +81299,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +81331,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 +81348,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +81688,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 +81865,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66169,7 +81908,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +81928,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 +81975,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +82013,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 +82032,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +82064,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 +82081,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +82492,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 +82666,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66795,7 +82709,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +82730,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 +82777,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 +82816,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 +82835,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 +82868,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 +82885,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +83279,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 +83438,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67395,7 +83481,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +83502,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 +83549,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 +83588,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 +83607,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 +83640,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 +83657,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +84773,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 +85226,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69016,7 +85269,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +85290,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 +85337,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 +85376,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 +85395,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 +85428,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 +85445,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +85812,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 +85953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69571,7 +85996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86016,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 +86063,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +86101,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 +86120,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +86152,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 +86169,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +86493,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 +86670,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70118,7 +86713,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86733,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 +86780,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +86818,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 +86837,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +86869,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 +86886,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +88299,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 +88472,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71755,7 +88515,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +88537,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 +88584,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 +88624,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 +88643,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 +88677,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 +88694,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +89050,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 +89227,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72336,7 +89270,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +89290,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 +89337,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +89375,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 +89394,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +89426,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 +89443,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +89783,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 +89960,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72899,7 +90003,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +90023,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 +90070,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +90108,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 +90127,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +90159,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 +90176,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +90516,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 +90693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73462,7 +90736,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +90756,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 +90803,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +90841,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 +90860,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +90892,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 +90909,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +91249,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 +91426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74025,7 +91469,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +91489,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 +91536,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +91574,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 +91593,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +91625,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 +91642,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +91982,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 +92159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74588,7 +92202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +92222,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 +92269,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +92307,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 +92326,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +92358,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 +92375,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +92715,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 +92892,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75151,7 +92935,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +92955,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 +93002,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +93040,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 +93059,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +93091,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 +93108,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +93448,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 +93625,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75714,7 +93668,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +93688,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 +93735,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +93773,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 +93792,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +93824,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 +93841,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +94181,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 +94358,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76277,7 +94401,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +94421,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 +94468,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +94506,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 +94525,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +94557,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 +94574,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +94914,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 +95091,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76840,7 +95134,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +95154,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 +95201,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +95239,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 +95258,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +95290,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 +95307,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +95822,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 +96080,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77629,7 +96123,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +96144,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 +96191,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 +96230,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 +96249,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 +96282,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 +96299,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +96673,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 +96850,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78227,7 +96893,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +96913,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 +96960,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +96998,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 +97017,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +97049,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 +97066,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +97406,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 +97583,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78790,7 +97626,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +97646,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 +97693,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +97731,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 +97750,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +97782,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 +97799,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +98218,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 +98392,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79424,7 +98435,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +98456,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 +98503,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 +98542,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 +98561,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 +98594,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 +98611,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +98954,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 +99131,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79991,7 +99174,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +99194,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 +99241,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +99279,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 +99298,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +99330,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 +99347,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +99749,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 +99899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80589,7 +99942,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +99963,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 +100010,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 +100049,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 +100068,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 +100101,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 +100118,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +100502,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 +100652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81170,7 +100695,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +100716,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 +100763,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 +100802,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 +100821,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 +100854,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 +100871,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +101193,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 +101370,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81716,7 +101413,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +101433,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 +101480,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +101518,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 +101537,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +101569,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 +101586,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +101926,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 +102103,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82279,7 +102146,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +102166,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 +102213,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +102251,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 +102270,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +102302,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 +102319,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +102659,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 +102836,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82842,7 +102879,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +102899,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 +102946,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +102984,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 +103003,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +103035,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 +103052,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +103762,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 +104046,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83881,7 +104089,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104111,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 +104158,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 +104198,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 +104217,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 +104251,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 +104268,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +104677,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 +104854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84515,7 +104897,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104917,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 +104964,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +105002,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 +105021,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +105053,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 +105070,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +105923,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": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "beginDate", + "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 +106261,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85707,7 +106304,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +106326,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 +106373,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 +106413,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 +106432,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 +106466,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 +106483,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +106907,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 +107084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86356,7 +107127,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +107147,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 +107194,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +107232,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 +107251,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +107283,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 +107300,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +107799,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 +108006,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87098,7 +108049,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +108072,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 +108119,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 +108160,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 +108179,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 +108214,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 +108231,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +108589,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 +108766,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87682,7 +108809,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +108829,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 +108876,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +108914,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 +108933,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +108965,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 +108982,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +110254,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 +110445,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89186,7 +110488,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +110510,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 +110557,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 +110597,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 +110616,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 +110650,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 +110667,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +111030,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 +111207,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89774,7 +111250,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +111270,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 +111317,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +111355,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 +111374,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +111406,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 +111423,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +111763,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 +111940,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90337,7 +111983,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +112003,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 +112050,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +112088,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 +112107,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +112139,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 +112156,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +112496,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 +112673,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90900,7 +112716,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +112736,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 +112783,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +112821,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 +112840,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +112872,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 +112889,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +113229,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 +113406,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91463,7 +113449,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +113469,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 +113516,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +113554,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 +113573,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +113605,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 +113622,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +113962,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 +114139,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92026,7 +114182,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +114202,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 +114249,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +114287,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 +114306,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +114338,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 +114355,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +114695,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 +114872,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92589,7 +114915,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +114935,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 +114982,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +115020,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 +115039,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +115071,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 +115088,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +115428,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 +115605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93152,7 +115648,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +115668,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 +115715,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +115753,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 +115772,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +115804,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 +115821,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +116161,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 +116338,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93715,7 +116381,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +116401,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 +116448,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +116486,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 +116505,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +116537,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 +116554,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +116894,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 +117071,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94278,7 +117114,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +117134,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 +117181,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +117219,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 +117238,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +117270,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 +117287,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +117627,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 +117804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94841,7 +117847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +117867,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 +117914,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +117952,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 +117971,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +118003,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 +118020,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +118360,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 +118537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95404,7 +118580,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +118600,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 +118647,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +118685,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 +118704,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +118736,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 +118753,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +119093,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 +119270,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95967,7 +119313,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +119333,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 +119380,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +119418,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 +119437,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +119469,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 +119486,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +119826,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 +120003,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96530,7 +120046,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +120066,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 +120113,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +120151,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 +120170,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +120202,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 +120219,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +120559,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 +120736,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97093,7 +120779,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +120799,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 +120846,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +120884,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 +120903,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +120935,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 +120952,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +121292,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 +121469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97656,7 +121512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +121532,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 +121579,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +121617,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 +121636,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +121668,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 +121685,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +122025,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 +122202,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98219,7 +122245,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +122265,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 +122312,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +122350,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 +122369,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +122401,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 +122418,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +122758,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 +122935,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98782,7 +122978,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +122998,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 +123045,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +123083,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 +123102,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +123134,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 +123151,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +123978,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 +124165,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99842,7 +124208,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +124229,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 +124276,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 +124315,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 +124334,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 +124367,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 +124384,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +125369,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 +125557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101062,7 +125600,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +125621,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 +125668,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 +125707,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 +125726,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 +125759,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 +125776,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +126868,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 +127073,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102406,7 +127116,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +127138,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 +127185,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 +127225,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 +127244,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 +127278,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 +127295,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +127663,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 +127840,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102999,7 +127883,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +127903,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 +127950,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +127988,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 +128007,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +128039,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 +128056,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +128396,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 +128573,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103562,7 +128616,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +128636,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 +128683,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +128721,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 +128740,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +128772,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 +128789,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +129129,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 +129306,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104125,7 +129349,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +129369,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 +129416,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +129454,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 +129473,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +129505,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 +129522,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +129862,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 +130039,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104688,7 +130082,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +130102,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 +130149,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +130187,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 +130206,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +130238,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 +130255,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +130697,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 +130882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105355,7 +130925,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +130945,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 +130992,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +131030,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 +131049,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +131081,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 +131098,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +131444,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 +131621,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105924,7 +131664,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +131684,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 +131731,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +131769,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 +131788,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +131820,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 +131837,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +132177,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 +132354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106487,7 +132397,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +132417,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 +132464,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +132502,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 +132521,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +132553,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 +132570,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +133506,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 +133716,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107684,7 +133759,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +133785,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 +133832,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 +133876,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 +133895,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 +133933,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 +133950,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +134327,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 +134504,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108290,7 +134547,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +134567,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 +134614,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +134652,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 +134671,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +134703,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 +134720,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +135060,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 +135237,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108853,7 +135280,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +135300,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 +135347,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +135385,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 +135404,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +135436,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 +135453,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +135793,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 +135970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109416,7 +136013,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +136033,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 +136080,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +136118,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 +136137,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +136169,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 +136186,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +136526,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 +136703,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109979,7 +136746,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +136766,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 +136813,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +136851,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 +136870,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +136902,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 +136919,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +137448,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 +137633,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110734,7 +137676,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +137697,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 +137744,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 +137783,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 +137802,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 +137835,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 +137852,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +138288,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": [ + "asOfDate", + "accountIdentifier", + "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 +138477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111396,7 +138520,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +138541,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 +138588,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 +138627,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 +138646,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 +138679,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 +138696,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +139127,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": [ + "asOfDate", + "accountIdentifier", + "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 +139316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112053,7 +139359,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +139380,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 +139427,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 +139466,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 +139485,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 +139518,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 +139535,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +140010,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": [ + "asOfDate", + "accountIdentifier", + "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 +140214,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112764,7 +140257,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +140278,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 +140325,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 +140364,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 +140383,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 +140416,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 +140433,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +142317,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 +142528,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114911,7 +142571,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +142594,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 +142641,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 +142682,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 +142701,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 +142736,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 +142753,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +143137,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 +143314,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115521,7 +143357,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +143377,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 +143424,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +143462,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 +143481,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +143513,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 +143530,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +143957,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": [ + "asOfDate", + "accountIdentifier", + "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 +144146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116173,7 +144189,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +144210,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 +144257,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 +144296,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 +144315,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 +144348,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 +144365,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +144840,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": [ + "asOfDate", + "accountIdentifier", + "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 +145044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116884,7 +145087,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +145108,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 +145155,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 +145194,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 +145213,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 +145246,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 +145263,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +145614,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 +145791,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117459,7 +145834,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +145854,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 +145901,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +145939,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 +145958,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +145990,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 +146007,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +146384,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 +146543,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118041,7 +146586,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +146608,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 +146655,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 +146695,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 +146714,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 +146748,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 +146765,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +147099,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 +147276,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118600,7 +147319,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +147339,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 +147386,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +147424,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 +147443,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +147475,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 +147492,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +147832,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 +148009,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119163,7 +148052,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +148072,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 +148119,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +148157,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 +148176,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +148208,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 +148225,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +148565,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 +148742,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119726,7 +148785,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +148805,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 +148852,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +148890,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 +148909,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +148941,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 +148958,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +149298,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 +149475,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120289,7 +149518,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +149538,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 +149585,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +149623,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 +149642,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +149674,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 +149691,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +150031,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 +150208,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120852,7 +150251,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +150271,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 +150318,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +150356,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 +150375,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +150407,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 +150424,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +150764,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 +150941,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121415,7 +150984,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +151004,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 +151051,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +151089,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 +151108,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +151140,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 +151157,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +151497,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 +151674,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121978,7 +151717,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +151737,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 +151784,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +151822,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 +151841,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +151873,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 +151890,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +152230,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 +152407,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122541,7 +152450,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +152470,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 +152517,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +152555,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 +152574,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +152606,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 +152623,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +152963,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 +153140,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123104,7 +153183,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +153203,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 +153250,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +153288,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 +153307,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +153339,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 +153356,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +153696,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 +153873,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123667,7 +153916,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +153936,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 +153983,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +154021,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 +154040,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +154072,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 +154089,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +154491,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 +154641,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124265,7 +154684,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +154705,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 +154752,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 +154791,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 +154810,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 +154843,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 +154860,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +155797,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", + "namespace", + "identificationCode" + ], + "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 +156010,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125456,7 +156053,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +156075,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 +156122,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 +156162,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 +156181,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 +156215,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 +156232,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +156853,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 +157057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126329,7 +157100,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +157121,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 +157168,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 +157207,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 +157226,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 +157259,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 +157276,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +157638,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 +157815,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126915,7 +157858,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +157878,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 +157925,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +157963,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 +157982,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +158014,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 +158031,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +158433,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 +158583,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127513,7 +158626,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +158647,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 +158694,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 +158733,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 +158752,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 +158785,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 +158802,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +160216,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 +160398,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129161,7 +160441,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +160461,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 +160614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160646,6 @@ }, { "$ref": "#/components/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 +160672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129340,7 +160729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160975,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 +161152,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129745,7 +161195,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +161215,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 +161368,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +161400,6 @@ }, { "$ref": "#/components/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 +161426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129924,7 +161483,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +161708,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 +161885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130308,7 +161928,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +161948,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 +161995,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +162033,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 +162052,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +162084,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 +162101,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +162441,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 +162618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130871,7 +162661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +162681,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 +162728,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +162766,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 +162785,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +162817,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 +162834,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +163160,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 +163301,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131384,7 +163344,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +163366,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 +163523,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +163555,6 @@ }, { "$ref": "#/components/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 +163581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131565,7 +163638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +163840,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 +164017,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131926,7 +164060,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +164080,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 +164233,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +164265,6 @@ }, { "$ref": "#/components/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 +164291,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132105,7 +164348,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +164573,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 +164750,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132489,7 +164793,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +164813,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 +164860,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +164898,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 +164917,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +164949,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 +164966,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +165306,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 +165483,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133052,7 +165526,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +165546,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 +165593,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +165631,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 +165650,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +165682,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 +165699,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +166039,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 +166216,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133615,7 +166259,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +166279,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 +166326,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +166364,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 +166383,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +166415,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 +166432,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +166772,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 +166949,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134178,7 +166992,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +167012,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 +167059,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +167097,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 +167116,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +167148,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 +167165,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +167505,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 +167682,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134741,7 +167725,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +167745,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 +167792,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +167830,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 +167849,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +167881,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 +167898,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +168301,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 +168467,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135351,7 +168510,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +168531,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 +168578,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 +168617,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 +168636,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 +168669,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 +168686,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +169015,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 +169192,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135904,7 +169235,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +169255,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 +169302,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +169340,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 +169359,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +169391,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 +169408,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +170884,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 +171065,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137612,7 +171108,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +171130,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 +171177,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 +171217,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 +171236,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 +171270,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 +171287,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +171649,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 +171826,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138199,7 +171869,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +171889,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 +171936,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +171974,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 +171993,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +172025,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 +172042,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +172382,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 +172559,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138762,7 +172602,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +172622,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 +172669,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +172707,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 +172726,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +172758,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 +172775,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +173115,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 +173292,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139325,7 +173335,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +173355,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 +173402,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +173440,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 +173459,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +173491,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 +173508,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +173848,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 +174025,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139888,7 +174068,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +174088,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 +174135,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +174173,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 +174192,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +174224,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 +174241,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +174581,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 +174758,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -140451,7 +174801,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +174821,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 +174868,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +174906,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 +174925,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +174957,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 +174974,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +175314,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 +175491,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141014,7 +175534,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +175554,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 +175601,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +175639,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 +175658,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +175690,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 +175707,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +176047,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 +176224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141577,7 +176267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +176287,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 +176334,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +176372,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 +176391,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +176423,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 +176440,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +176842,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 +176992,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142175,7 +177035,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +177056,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 +177103,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 +177142,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 +177161,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 +177194,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 +177211,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +177939,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": [ + "programEvaluationElementTitle", + "programEducationOrganizationId", + "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 +178201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143187,7 +178244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +178265,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 +178312,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 +178351,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 +178370,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 +178403,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 +178420,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +179086,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": [ + "programEvaluationObjectiveTitle", + "programEducationOrganizationId", + "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 +179338,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144127,7 +179381,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +179402,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 +179449,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 +179488,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 +179507,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 +179540,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 +179557,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +179938,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 +180115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144732,7 +180158,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +180178,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 +180225,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +180263,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 +180282,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +180314,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 +180331,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +180671,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 +180848,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145295,7 +180891,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +180911,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 +180958,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +180996,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 +181015,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +181047,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 +181064,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +181668,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": [ + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programEducationOrganizationId", + "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 +181896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146153,7 +181939,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +181960,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 +182007,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 +182046,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 +182065,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 +182098,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 +182115,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +182483,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 +182660,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146745,7 +182703,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +182723,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 +182770,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +182808,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 +182827,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +182859,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 +182876,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +183216,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 +183393,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147308,7 +183436,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +183456,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 +183503,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +183541,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 +183560,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +183592,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 +183609,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +184179,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 +184344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148084,7 +184387,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +184418,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 +184465,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 +184514,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 +184533,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 +184576,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 +184593,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +184941,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 +185118,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148666,7 +185161,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +185181,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 +185228,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +185266,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 +185285,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +185317,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 +185334,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +185674,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 +185851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149229,7 +185894,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +185914,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 +185961,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +185999,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 +186018,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +186050,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 +186067,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +186469,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 +186619,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149827,7 +186662,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +186683,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 +186730,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 +186769,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 +186788,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 +186821,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 +186838,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +187160,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 +187337,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150373,7 +187380,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +187400,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 +187447,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +187485,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 +187504,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +187536,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 +187553,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +187893,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 +188070,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150936,7 +188113,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +188133,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 +188180,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +188218,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 +188237,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +188269,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 +188286,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +188626,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 +188803,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151499,7 +188846,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +188866,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 +188913,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +188951,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 +188970,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +189002,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 +189019,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +189359,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 +189536,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152062,7 +189579,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +189599,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 +189646,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +189684,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 +189703,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +189735,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 +189752,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +190092,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 +190269,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152625,7 +190312,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +190332,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 +190379,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +190417,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 +190436,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +190468,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 +190485,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +190825,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 +191002,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153188,7 +191045,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +191065,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 +191112,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +191150,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 +191169,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +191201,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 +191218,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +191558,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 +191735,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153751,7 +191778,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +191798,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 +191845,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +191883,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 +191902,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +191934,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 +191951,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +192291,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 +192468,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154314,7 +192511,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +192531,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 +192578,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +192616,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 +192635,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +192667,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 +192684,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +193024,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 +193201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154877,7 +193244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +193264,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 +193311,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +193349,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 +193368,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +193400,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 +193417,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +193757,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 +193934,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155440,7 +193977,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +193997,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 +194044,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +194082,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 +194101,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +194133,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 +194150,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +194490,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 +194667,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156003,7 +194710,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +194730,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 +194777,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +194815,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 +194834,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +194866,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 +194883,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +195223,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 +195400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156566,7 +195443,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +195463,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 +195510,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +195548,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 +195567,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +195599,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 +195616,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +196636,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 +196864,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157840,7 +196907,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +196929,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 +196976,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 +197016,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 +197035,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 +197069,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 +197086,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +197455,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 +197632,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158434,7 +197675,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +197695,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 +197742,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +197780,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 +197799,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +197831,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 +197848,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +198188,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 +198365,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158997,7 +198408,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +198428,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 +198475,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +198513,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 +198532,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +198564,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 +198581,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +198921,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 +199098,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159560,7 +199141,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +199161,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 +199208,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +199246,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 +199265,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +199297,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 +199314,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +199654,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 +199831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160123,7 +199874,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +199894,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 +199941,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +199979,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 +199998,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +200030,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 +200047,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +200387,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 +200564,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160686,7 +200607,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +200627,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 +200674,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +200712,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 +200731,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +200763,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 +200780,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +201120,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 +201297,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161249,7 +201340,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +201360,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 +201407,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +201445,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 +201464,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +201496,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 +201513,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +202077,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 +202251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162028,7 +202294,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +202315,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 +202362,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 +202401,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 +202420,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 +202453,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 +202470,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +202814,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 +202991,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162596,7 +203034,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +203054,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 +203101,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +203139,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 +203158,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +203190,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 +203207,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +203547,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 +203724,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163159,7 +203767,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +203787,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 +203834,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +203872,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 +203891,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +203923,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 +203940,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +204280,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 +204457,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163722,7 +204500,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +204520,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 +204567,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +204605,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 +204624,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +204656,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 +204673,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +205013,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 +205190,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164285,7 +205233,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +205253,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 +205300,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +205338,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 +205357,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +205389,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 +205406,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +205746,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 +205923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164848,7 +205966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +205986,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 +206033,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +206071,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 +206090,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +206122,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 +206139,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +206479,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 +206656,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165411,7 +206699,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +206719,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 +206766,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +206804,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 +206823,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +206855,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 +206872,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +207212,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 +207389,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165974,7 +207432,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +207452,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 +207499,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +207537,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 +207556,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +207588,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 +207605,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +207914,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 +208055,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166475,7 +208098,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +208118,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 +208271,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +208303,6 @@ }, { "$ref": "#/components/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 +208329,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166654,7 +208386,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +209971,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 +210216,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168471,7 +210259,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +210293,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 +210474,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +210506,6 @@ }, { "$ref": "#/components/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 +210532,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168664,7 +210589,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +211097,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 +211332,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169364,7 +211375,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +211396,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 +211443,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 +211482,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 +211501,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 +211534,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 +211551,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +211917,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 +212094,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169954,7 +212137,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +212157,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 +212204,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +212242,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 +212261,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +212293,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 +212310,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +212650,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 +212827,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170517,7 +212870,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +212890,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 +212937,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +212975,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 +212994,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +213026,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 +213043,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +214103,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", + "sessionName", + "sectionIdentifier" + ], + "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 +214407,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171912,7 +214450,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +214482,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 +214529,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 +214579,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 +214598,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 +214642,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 +214659,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +215094,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 +215271,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172582,7 +215314,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +215334,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 +215381,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +215419,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 +215438,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +215470,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 +215487,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +215827,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 +216004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173145,7 +216047,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +216067,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 +216114,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +216152,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 +216171,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +216203,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 +216220,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +216560,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 +216737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173708,7 +216780,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +216800,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 +216847,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +216885,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 +216904,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +216936,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 +216953,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +217615,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 +217807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174603,7 +217850,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +217877,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 +217924,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 +217969,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 +217988,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 +218027,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 +218044,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +218401,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 +218578,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175190,7 +218621,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +218641,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 +218688,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +218726,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 +218745,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +218777,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 +218794,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +219196,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 +219346,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175788,7 +219389,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +219410,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 +219457,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 +219496,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 +219515,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 +219548,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 +219565,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +219887,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 +220064,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176334,7 +220107,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +220127,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 +220174,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +220212,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 +220231,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +220263,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 +220280,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +220620,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 +220797,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176897,7 +220840,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +220860,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 +220907,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +220945,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 +220964,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +220996,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 +221013,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +221353,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 +221530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177460,7 +221573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +221593,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 +221640,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +221678,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 +221697,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +221729,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 +221746,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +222086,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 +222263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178023,7 +222306,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +222326,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 +222373,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +222411,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 +222430,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +222462,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 +222479,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +222889,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 +223063,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178648,7 +223106,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +223127,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 +223174,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 +223213,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 +223232,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 +223265,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 +223282,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +223617,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 +223794,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179207,7 +223837,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +223857,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 +223904,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +223942,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 +223961,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +223993,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 +224010,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +224448,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 +224636,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179869,7 +224679,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +224700,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 +224747,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 +224786,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 +224805,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 +224838,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 +224855,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +225289,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 +225445,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180501,7 +225488,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +225508,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 +225555,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +225593,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 +225612,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +225644,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 +225661,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +226259,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 +226516,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181392,7 +226559,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +226581,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 +226628,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 +226668,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 +226687,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 +226721,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 +226738,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +227710,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 +227885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182582,7 +227928,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +227949,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 +227996,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 +228035,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 +228054,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 +228087,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 +228104,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +228729,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 +228992,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183507,7 +229035,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +229056,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 +229103,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 +229142,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 +229161,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 +229194,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 +229211,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +229604,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 +229781,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184124,7 +229824,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +229844,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 +229891,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +229929,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 +229948,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +229980,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 +229997,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +230337,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 +230514,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184687,7 +230557,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +230577,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 +230624,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +230662,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 +230681,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +230713,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 +230730,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +231153,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 +231335,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185333,7 +231378,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +231399,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 +231446,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 +231485,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 +231504,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 +231537,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 +231554,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +232015,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 +232218,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186029,7 +232261,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +232285,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 +232332,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 +232374,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 +232393,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 +232429,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 +232446,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +233059,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 +233234,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186862,7 +233277,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +233300,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 +233347,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 +233388,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 +233407,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 +233442,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 +233459,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +234026,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 +234285,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187712,7 +234328,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +234352,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 +234399,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 +234441,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 +234460,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 +234496,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 +234513,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +237355,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 +237673,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190927,7 +237716,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +237746,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 +237793,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 +237841,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 +237860,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 +237902,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 +237919,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +238368,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 +238545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191609,7 +238588,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +238608,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 +238655,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +238693,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 +238712,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +238744,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 +238761,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +240302,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 +240465,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193364,7 +240508,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +240530,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 +240577,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 +240617,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 +240636,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 +240670,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 +240687,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +242651,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 +242939,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195654,7 +242982,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +243005,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 +243052,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 +243093,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 +243112,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 +243147,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 +243164,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +243717,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": [ + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "assessmentIdentifier", + "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 +243929,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196447,7 +243972,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +243992,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 +244039,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +244077,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 +244096,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +244128,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 +244145,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +245764,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 +246073,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198410,7 +246116,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +246138,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 +246185,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 +246225,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 +246244,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 +246278,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 +246295,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +247205,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 +247457,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199600,7 +247500,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +247520,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 +247567,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +247605,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 +247624,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +247656,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 +247673,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +248061,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 +248238,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200211,7 +248281,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +248301,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 +248348,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +248386,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 +248405,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +248437,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 +248454,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +248988,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 +249168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200961,7 +249211,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +249233,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 +249280,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 +249320,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 +249339,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 +249373,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 +249390,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +250178,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", + "objectiveEducationOrganizationId", + "objective", + "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 +250427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202016,7 +250470,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +250492,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 +250539,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 +250579,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 +250598,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 +250632,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 +250649,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +251161,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 +251361,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202776,7 +251404,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +251425,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 +251472,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 +251511,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 +251530,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 +251563,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 +251580,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +252076,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 +252256,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203489,7 +252299,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +252319,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 +252366,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +252404,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 +252423,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +252455,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 +252472,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +252897,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 +253053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204111,7 +253096,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +253116,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 +253163,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +253201,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 +253220,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +253252,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 +253269,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +255825,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 +256102,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206990,7 +256145,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +256167,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 +256214,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 +256254,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 +256273,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 +256307,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 +256324,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +256823,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 +257003,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207707,7 +257046,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +257067,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 +257114,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 +257153,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 +257172,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 +257205,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 +257222,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +257779,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 +258017,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208543,7 +258060,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +258082,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 +258129,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 +258169,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 +258188,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 +258222,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 +258239,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +258935,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 +259103,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209455,7 +259146,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +259167,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 +259214,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 +259253,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 +259272,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 +259305,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 +259322,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +260126,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 +260378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210538,7 +260421,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +260441,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 +260488,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +260526,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 +260545,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +260577,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 +260594,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +260982,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 +261159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211149,7 +261202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +261222,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 +261269,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +261307,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 +261326,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +261358,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 +261375,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +261974,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 +262168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211983,7 +262211,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +262233,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 +262280,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 +262320,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 +262339,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 +262373,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 +262390,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +262925,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", + "eventDate", + "educationOrganizationId", + "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 +263147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212773,7 +263190,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +263211,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 +263258,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 +263297,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 +263316,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 +263349,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 +263366,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +264322,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 +264566,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214000,7 +264609,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +264629,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 +264676,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +264714,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 +264733,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +264765,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 +264782,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +265741,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 +266048,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215292,7 +266091,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +266111,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 +266158,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +266196,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 +266215,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +266247,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 +266264,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +267155,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 +267409,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216463,7 +267452,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +267472,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 +267519,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +267557,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 +267576,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +267608,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 +267625,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +268013,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 +268190,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217074,7 +268233,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +268253,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 +268300,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +268338,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 +268357,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +268389,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 +268406,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +269157,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 +269384,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218078,7 +269427,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +269454,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 +269501,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 +269546,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 +269565,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 +269604,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 +269621,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +270241,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 +270493,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218978,7 +270536,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +270559,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 +270606,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 +270647,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 +270666,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 +270701,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 +270718,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +271864,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 +272151,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220430,7 +272194,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +272215,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 +272262,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 +272301,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 +272320,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 +272353,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 +272370,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +273497,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 +273859,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221961,7 +273902,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +273927,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 +273974,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 +274017,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 +274036,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 +274073,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 +274090,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +274847,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 +275100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223002,7 +275143,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +275166,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 +275213,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 +275254,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 +275273,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 +275308,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 +275325,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +276133,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 +276368,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224074,7 +276411,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +276431,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 +276478,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +276516,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 +276535,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +276567,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 +276584,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +277274,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 +277533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225044,7 +277576,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +277605,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 +277652,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 +277699,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 +277718,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 +277759,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 +277776,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +278524,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 +278807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226100,7 +278850,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +278873,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 +278920,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 +278961,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 +278980,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 +279015,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 +279032,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +280412,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 +280753,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227850,7 +280796,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +280817,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 +280864,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 +280903,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 +280922,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 +280955,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 +280972,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +281832,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 +282151,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229061,7 +282194,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +282214,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 +282261,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +282299,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 +282318,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +282350,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 +282367,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +283225,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 +283461,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230181,7 +283504,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +283524,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 +283571,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +283609,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 +283628,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +283660,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 +283677,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +284291,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 +284484,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231034,7 +284527,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +284548,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 +284595,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 +284634,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 +284653,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 +284686,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 +284703,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +285921,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 +286220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232603,7 +286263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +286302,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 +286328,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 +286349,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 +286944,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 +287121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233296,7 +287164,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +287184,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 +287337,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287369,6 @@ }, { "$ref": "#/components/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 +287395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233475,7 +287452,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287677,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 +287854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233859,7 +287897,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +287917,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 +288070,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288102,6 @@ }, { "$ref": "#/components/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 +288128,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234038,7 +288185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288410,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 +288587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234422,7 +288630,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +288650,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 +288803,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288835,6 @@ }, { "$ref": "#/components/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 +288861,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234601,7 +288918,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289198,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 +289371,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235025,7 +289414,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +289435,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 +289590,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289622,6 @@ }, { "$ref": "#/components/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 +289648,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235205,7 +289705,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289923,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 +290100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235582,7 +290143,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +290163,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 +290316,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +290348,6 @@ }, { "$ref": "#/components/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 +290374,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235761,7 +290431,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +290730,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", + "programName", + "programTypeDescriptor", + "namespace", + "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 +290918,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236214,7 +290961,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +290982,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 +291137,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +291169,6 @@ }, { "$ref": "#/components/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 +291195,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236394,7 +291252,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +291844,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 +292034,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237147,7 +292077,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +292098,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 +292253,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +292285,6 @@ }, { "$ref": "#/components/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 +292311,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237327,7 +292368,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +292914,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": [ + "questionCode", + "namespace", + "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 +293100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238035,7 +293143,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +293164,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 +293319,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293351,6 @@ }, { "$ref": "#/components/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 +293377,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238215,7 +293434,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293716,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 +293889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238641,7 +293932,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +293953,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 +294108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294140,6 @@ }, { "$ref": "#/components/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 +294166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238821,7 +294223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294496,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": [ + "staffUniqueId", + "namespace", + "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 +294669,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239238,7 +294712,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +294733,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 +294888,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294920,6 @@ }, { "$ref": "#/components/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 +294946,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239418,7 +295003,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295478,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 +295712,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240103,7 +295755,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +295776,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 +295931,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295963,6 @@ }, { "$ref": "#/components/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 +295989,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240283,7 +296046,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296420,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", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "namespace", + "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 +296638,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240831,7 +296681,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +296702,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 +296857,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296889,6 @@ }, { "$ref": "#/components/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 +296915,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241011,7 +296972,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297293,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 +297481,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241486,7 +297524,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +297545,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 +297700,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297732,6 @@ }, { "$ref": "#/components/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 +297758,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241666,7 +297815,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298124,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": [ + "staffUniqueId", + "namespace", + "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 +298312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242129,7 +298355,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +298376,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 +298531,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298563,6 @@ }, { "$ref": "#/components/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 +298589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242309,7 +298646,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298980,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": [ + "surveyResponseIdentifier", + "namespace", + "surveyIdentifier", + "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 +299162,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242796,7 +299205,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +299226,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 +299381,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299413,6 @@ }, { "$ref": "#/components/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 +299439,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242976,7 +299496,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299737,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 +299895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243351,7 +299938,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +299959,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 +300114,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300146,6 @@ }, { "$ref": "#/components/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 +300172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243531,7 +300229,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300616,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 +300825,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244108,7 +300868,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +300889,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 +301044,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301076,6 @@ }, { "$ref": "#/components/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 +301102,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244288,7 +301159,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301403,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 +301580,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244691,7 +301623,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +301643,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 +301796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301828,6 @@ }, { "$ref": "#/components/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 +301854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244870,7 +301911,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302136,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 +302313,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245254,7 +302356,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +302376,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 +302529,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302561,6 @@ }, { "$ref": "#/components/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 +302587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245433,7 +302644,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302869,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 +303046,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245817,7 +303089,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +303109,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 +303262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303294,6 @@ }, { "$ref": "#/components/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 +303320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245996,7 +303377,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303602,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 +303779,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246380,7 +303822,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +303842,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 +303995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304027,6 @@ }, { "$ref": "#/components/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 +304053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246559,7 +304110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304335,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 +304512,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246943,7 +304555,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +304575,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 +304728,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304760,6 @@ }, { "$ref": "#/components/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 +304786,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247122,7 +304843,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305068,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 +305245,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247506,7 +305288,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +305308,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 +305461,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305493,6 @@ }, { "$ref": "#/components/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 +305519,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247685,7 +305576,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305801,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 +305978,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248069,7 +306021,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +306041,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 +306194,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +306226,6 @@ }, { "$ref": "#/components/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 +306252,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248248,7 +306309,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +306534,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 +306711,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248632,7 +306754,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +306774,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 +306927,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +306959,6 @@ }, { "$ref": "#/components/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 +306985,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248811,7 +307042,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307267,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 +307444,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249195,7 +307487,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +307507,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 +307660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307692,6 @@ }, { "$ref": "#/components/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 +307718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249374,7 +307775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308000,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 +308177,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249758,7 +308220,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +308240,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 +308393,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308425,6 @@ }, { "$ref": "#/components/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 +308451,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249937,7 +308508,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308733,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 +308910,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250321,7 +308953,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +308973,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 +309126,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309158,6 @@ }, { "$ref": "#/components/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 +309184,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250500,7 +309241,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309466,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 +309643,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250884,7 +309686,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +309706,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 +309859,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309891,6 @@ }, { "$ref": "#/components/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 +309917,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251063,7 +309974,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310199,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 +310376,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251447,7 +310419,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +310439,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 +310592,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310624,6 @@ }, { "$ref": "#/components/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 +310650,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251626,7 +310707,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310932,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 +311109,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252010,7 +311152,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +311172,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 +311325,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +311357,6 @@ }, { "$ref": "#/components/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 +311383,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252189,7 +311440,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +311665,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 +311842,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252573,7 +311885,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +311905,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 +312058,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312090,6 @@ }, { "$ref": "#/components/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 +312116,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252752,7 +312173,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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..eb48dd28c 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": [ + "evaluationElementTitle", + "educationOrganizationId", + "evaluationDate", + "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": [ + "evaluationElementTitle", + "educationOrganizationId", + "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": [ + "evaluationObjectiveTitle", + "evaluationTitle", + "educationOrganizationId", + "evaluationDate", + "evaluationPeriodDescriptor", + "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": [ + "evaluationObjectiveTitle", + "educationOrganizationId", + "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": [ + "evaluationDate", + "evaluationTitle", + "performanceEvaluationTypeDescriptor", + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "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": [ + "evaluationTitle", + "educationOrganizationId", + "evaluationPeriodDescriptor", + "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", + "schoolYear", + "termDescriptor", + "personId", + "sourceSystemDescriptor" + ], + "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", + "schoolYear", + "termDescriptor", + "rubricRating" + ], + "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": [ + "personId", + "sourceSystemDescriptor", + "namespace", + "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": [ + "personId", + "sourceSystemDescriptor", + "namespace", + "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..31ee55ffa 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": { @@ -1124,9 +1184,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." }, @@ -1310,9 +1367,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 +1911,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 +2088,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2016,7 +2131,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +2151,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 +2304,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2336,6 @@ }, { "$ref": "#/components/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 +2362,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2195,7 +2419,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2644,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 +2821,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2579,7 +2864,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +2884,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 +2931,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +2969,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 +2988,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +3020,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 +3037,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +3377,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 +3554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3142,7 +3597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +3617,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 +3664,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +3702,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 +3721,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +3753,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 +3770,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +4173,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 +4343,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3760,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" @@ -3781,27 +4407,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 +4454,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 +4493,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 +4512,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 +4545,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 +4562,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +4900,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 +5077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4322,7 +5120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +5140,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 +5187,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +5225,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 +5244,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +5276,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 +5293,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +5633,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 +5810,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4885,7 +5853,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +5873,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 +5920,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +5958,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 +5977,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +6009,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 +6026,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +6487,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 +6679,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5579,7 +6722,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +6744,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 +6791,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 +6831,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 +6850,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 +6884,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 +6901,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +7252,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 +7429,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6155,7 +7472,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +7492,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 +7539,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +7577,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 +7596,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +7628,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 +7645,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +7985,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 +8162,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6718,7 +8205,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +8225,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 +8272,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +8310,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 +8329,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +8361,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 +8378,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +8718,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 +8895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7281,7 +8938,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +8958,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 +9005,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +9043,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 +9062,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +9094,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 +9111,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +9451,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 +9628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7844,7 +9671,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +9691,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 +9738,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +9776,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 +9795,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +9827,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 +9844,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +10184,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 +10361,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8407,7 +10404,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +10424,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 +10471,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +10509,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 +10528,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +10560,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 +10577,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +10917,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 +11094,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8970,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" @@ -8990,27 +11157,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 +11204,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +11242,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 +11261,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +11293,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 +11310,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +11874,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 +12062,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9752,7 +12105,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +12126,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 +12173,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 +12212,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 +12231,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 +12264,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 +12281,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +12853,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", + "namespace", + "assigningEducationOrganizationId" + ], + "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 +13026,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10533,7 +13069,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +13090,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 +13137,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 +13176,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 +13195,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 +13228,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 +13245,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +13699,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 +13857,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11186,7 +13900,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +13921,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 +13968,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 +14007,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 +14026,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 +14059,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 +14076,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +14400,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 +14577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11734,7 +14620,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +14640,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 +14687,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +14725,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 +14744,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +14776,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 +14793,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +15133,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 +15310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12297,7 +15353,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +15373,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 +15420,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +15458,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 +15477,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +15509,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 +15526,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +15866,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 +16043,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12860,7 +16086,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +16106,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 +16153,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +16191,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 +16210,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +16242,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 +16259,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +16599,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 +16776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13423,7 +16819,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +16839,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 +16886,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +16924,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 +16943,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +16975,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 +16992,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +17622,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", + "namespace", + "identificationCode" + ], + "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 +17835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14306,7 +17878,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +17900,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 +17947,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 +17987,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 +18006,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 +18040,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 +18057,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +18417,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 +18594,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14891,7 +18637,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +18657,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 +18704,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +18742,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 +18761,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +18793,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 +18810,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +19150,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 +19327,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15454,7 +19370,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +19390,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 +19437,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +19475,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 +19494,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +19526,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 +19543,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +20096,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 +20291,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16242,7 +20334,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +20355,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 +20402,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 +20441,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 +20460,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 +20493,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 +20510,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +22167,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 +22400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18178,7 +22443,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +22465,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 +22512,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 +22552,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 +22571,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 +22605,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 +22622,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +23009,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 +23186,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18790,7 +23229,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +23249,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 +23296,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +23334,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 +23353,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +23385,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 +23402,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +23742,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 +23919,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19353,7 +23962,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +23982,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 +24029,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +24067,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 +24086,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +24118,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 +24135,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +24475,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 +24652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19916,7 +24695,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +24715,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 +24762,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +24800,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 +24819,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +24851,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 +24868,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +25270,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 +25420,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20514,7 +25463,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +25484,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 +25531,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 +25570,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 +25589,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 +25622,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 +25639,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +25961,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 +26138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21060,7 +26181,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +26201,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 +26248,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +26286,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 +26305,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +26337,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 +26354,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +26694,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 +26871,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21623,7 +26914,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +26934,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 +26981,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +27019,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 +27038,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +27070,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 +27087,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +27687,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 +27862,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22444,7 +27905,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +27926,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 +27973,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 +28012,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 +28031,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 +28064,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 +28081,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +28425,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 +28602,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23012,7 +28645,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +28665,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 +28712,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +28750,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 +28769,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +28801,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 +28818,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +29256,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", + "schoolId", + "schoolYear", + "date" + ], + "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 +29427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23657,7 +29470,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +29491,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 +29538,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 +29577,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 +29596,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 +29629,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 +29646,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +29978,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 +30155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24213,7 +30198,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +30218,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 +30265,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +30303,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 +30322,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +30354,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 +30371,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +30711,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 +30888,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24776,7 +30931,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +30951,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 +30998,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +31036,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 +31055,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +31087,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 +31104,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +31566,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 +31731,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25444,7 +31774,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +31795,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 +31842,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 +31881,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 +31900,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 +31933,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 +31950,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +32282,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 +32459,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26000,7 +32502,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +32522,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 +32569,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +32607,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 +32626,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +32658,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 +32675,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +33577,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 +33831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27197,7 +33874,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +33895,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 +33942,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 +33981,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 +34000,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 +34033,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 +34050,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +34448,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 +34625,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27819,7 +34668,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +34688,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 +34735,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +34773,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 +34792,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +34824,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 +34841,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +35181,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 +35358,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28382,7 +35401,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +35421,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 +35468,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +35506,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 +35525,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +35557,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 +35574,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +35914,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 +36091,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28945,7 +36134,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +36154,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 +36201,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +36239,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 +36258,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +36290,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 +36307,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +36736,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 +36885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29569,7 +36928,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +36951,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 +36998,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 +37039,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 +37058,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 +37093,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 +37110,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +37439,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 +37616,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30124,7 +37659,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +37679,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 +37726,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +37764,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 +37783,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +37815,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 +37832,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +38172,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 +38349,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30687,7 +38392,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +38412,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 +38459,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +38497,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 +38516,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +38548,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 +38565,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +38905,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 +39082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31250,7 +39125,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +39145,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 +39192,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +39230,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 +39249,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +39281,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 +39298,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +39638,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 +39815,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31813,7 +39858,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +39878,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 +39925,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +39963,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 +39982,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +40014,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 +40031,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +40538,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 +40715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32543,7 +40758,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +40780,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 +40827,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 +40867,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 +40886,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 +40920,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 +40937,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +42044,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 +42488,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34147,7 +42531,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +42552,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 +42599,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 +42638,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 +42657,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 +42690,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 +42707,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +43241,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 +43469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34951,7 +43512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +43533,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 +43580,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 +43619,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 +43638,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 +43671,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 +43688,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +44952,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 +45449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36764,7 +45492,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +45513,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 +45560,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 +45599,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 +45618,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 +45651,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 +45668,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +46053,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 +46230,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37373,7 +46273,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +46293,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 +46340,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +46378,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 +46397,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +46429,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 +46446,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +46870,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 +47053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38021,7 +47096,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +47118,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 +47165,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 +47205,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 +47224,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 +47258,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 +47275,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +47620,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 +47797,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38591,7 +47840,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +47860,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 +47907,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +47945,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 +47964,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +47996,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 +48013,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +49867,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 +50121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40750,7 +50164,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +50186,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 +50233,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 +50273,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 +50292,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 +50326,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 +50343,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +50747,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 +50924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41379,7 +50967,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +50987,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 +51034,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +51072,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 +51091,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +51123,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 +51140,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +51480,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 +51657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41942,7 +51700,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +51720,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 +51767,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +51805,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 +51824,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +51856,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 +51873,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +52213,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 +52390,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -42505,7 +52433,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +52453,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 +52500,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +52538,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 +52557,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +52589,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 +52606,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +52946,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 +53123,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43068,7 +53166,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +53186,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 +53233,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +53271,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 +53290,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +53322,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 +53339,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +53679,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 +53856,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43631,7 +53899,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +53919,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 +53966,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +54004,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 +54023,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +54055,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 +54072,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +54412,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 +54589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44194,7 +54632,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +54652,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 +54699,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +54737,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 +54756,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +54788,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 +54805,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +55145,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 +55322,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44757,7 +55365,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +55385,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 +55432,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +55470,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 +55489,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +55521,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 +55538,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +55878,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 +56055,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45320,7 +56098,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +56118,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 +56165,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +56203,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 +56222,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +56254,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 +56271,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +56611,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 +56788,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45883,7 +56831,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +56851,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 +56898,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +56936,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 +56955,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +56987,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 +57004,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +57680,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 +57889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46804,7 +57932,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +57956,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 +58003,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 +58045,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 +58064,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 +58100,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 +58117,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +58480,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 +58657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47394,7 +58700,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +58720,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 +58767,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +58805,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 +58824,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +58856,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 +58873,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +60383,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 +60764,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49306,7 +60807,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +60830,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 +60877,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 +60918,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 +60937,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 +60972,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 +60989,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +62201,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 +62485,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50851,7 +62528,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +62555,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 +62602,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 +62647,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 +62666,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 +62705,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 +62722,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +63150,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 +63327,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51509,7 +63370,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +63390,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 +63437,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +63475,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 +63494,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +63526,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 +63543,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +63883,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 +64060,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52072,7 +64103,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +64123,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 +64170,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +64208,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 +64227,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +64259,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 +64276,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +64928,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 +65142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52984,7 +65185,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +65206,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 +65253,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 +65292,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 +65311,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 +65344,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 +65361,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +65731,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 +65908,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53578,7 +65951,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +65971,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 +66018,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +66056,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 +66075,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +66107,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 +66124,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +66464,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 +66641,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54141,7 +66684,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +66704,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 +66751,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +66789,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 +66808,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +66840,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 +66857,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +67229,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 +67391,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54726,7 +67434,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +67455,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 +67502,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 +67541,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 +67560,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 +67593,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 +67610,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +67944,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 +68121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55284,7 +68164,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +68184,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 +68231,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +68269,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 +68288,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +68320,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 +68337,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +68677,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 +68854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55847,7 +68897,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +68917,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 +68964,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +69002,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 +69021,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +69053,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 +69070,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +69410,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 +69587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56410,7 +69630,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +69650,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 +69697,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +69735,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 +69754,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +69786,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 +69803,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +70143,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 +70320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56973,7 +70363,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +70383,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 +70430,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +70468,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 +70487,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +70519,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 +70536,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +70977,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 +71152,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57623,7 +71195,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +71215,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 +71262,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +71300,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 +71319,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +71351,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 +71368,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +71696,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 +71873,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58174,7 +71916,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +71936,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 +71983,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +72021,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 +72040,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +72072,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 +72089,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +72429,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 +72606,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58737,7 +72649,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +72669,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 +72716,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +72754,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 +72773,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +72805,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 +72822,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +73162,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 +73339,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59300,7 +73382,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +73402,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 +73449,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +73487,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 +73506,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +73538,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 +73555,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +73895,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 +74072,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59863,7 +74115,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +74135,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 +74182,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +74220,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 +74239,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +74271,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 +74288,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +74628,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 +74805,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60426,7 +74848,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +74868,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 +74915,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +74953,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 +74972,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +75004,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 +75021,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +75361,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 +75538,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60989,7 +75581,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +75601,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 +75648,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +75686,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 +75705,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +75737,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 +75754,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +76094,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 +76271,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61552,7 +76314,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +76334,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 +76381,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +76419,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 +76438,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +76470,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 +76487,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +77246,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 +77465,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62571,7 +77508,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +77529,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 +77576,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 +77615,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 +77634,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 +77667,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 +77684,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +78059,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 +78236,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63170,7 +78279,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +78299,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 +78346,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +78384,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 +78403,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +78435,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 +78452,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +78792,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 +78969,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63733,7 +79012,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +79032,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 +79079,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +79117,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 +79136,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +79168,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 +79185,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +79910,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 +80142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64736,7 +80185,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +80206,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 +80253,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 +80292,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 +80311,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 +80344,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 +80361,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +80740,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 +80917,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65339,7 +80960,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +80980,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 +81027,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +81065,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 +81084,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +81116,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 +81133,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +81473,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 +81650,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65902,7 +81693,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +81713,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 +81760,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +81798,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 +81817,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +81849,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 +81866,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +82206,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 +82383,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66465,7 +82426,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +82446,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 +82493,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +82531,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 +82550,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +82582,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 +82599,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +83578,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 +83851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67768,7 +83894,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +83915,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 +83962,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 +84001,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 +84020,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 +84053,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 +84070,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +84482,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 +84659,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68404,7 +84702,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +84722,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 +84769,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +84807,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 +84826,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +84858,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 +84875,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +85215,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 +85392,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68967,7 +85435,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +85455,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 +85502,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +85540,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 +85559,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +85591,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 +85608,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +85948,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 +86125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69530,7 +86168,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86188,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 +86235,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +86273,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 +86292,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +86324,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 +86341,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +86752,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 +86926,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70156,7 +86969,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86990,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 +87037,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 +87076,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 +87095,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 +87128,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 +87145,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +87539,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 +87698,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70756,7 +87741,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +87762,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 +87809,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 +87848,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 +87867,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 +87900,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 +87917,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +89033,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 +89486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72377,7 +89529,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +89550,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 +89597,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 +89636,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 +89655,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 +89688,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 +89705,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +90072,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 +90213,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72932,7 +90256,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +90276,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 +90323,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +90361,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 +90380,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +90412,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 +90429,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +90753,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 +90930,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73479,7 +90973,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +90993,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 +91040,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +91078,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 +91097,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +91129,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 +91146,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +92559,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 +92732,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75116,7 +92775,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +92797,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 +92844,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 +92884,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 +92903,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 +92937,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 +92954,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +93310,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 +93487,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75697,7 +93530,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +93550,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 +93597,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +93635,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 +93654,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +93686,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 +93703,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +94043,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 +94220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76260,7 +94263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +94283,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 +94330,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +94368,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 +94387,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +94419,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 +94436,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +94776,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 +94953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76823,7 +94996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +95016,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 +95063,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +95101,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 +95120,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +95152,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 +95169,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +95509,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 +95686,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77386,7 +95729,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +95749,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 +95796,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +95834,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 +95853,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +95885,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 +95902,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +96242,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 +96419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77949,7 +96462,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +96482,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 +96529,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +96567,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 +96586,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +96618,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 +96635,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +96975,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 +97152,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78512,7 +97195,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +97215,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 +97262,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +97300,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 +97319,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +97351,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 +97368,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +97708,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 +97885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79075,7 +97928,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +97948,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 +97995,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +98033,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 +98052,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +98084,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 +98101,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +98441,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 +98618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79638,7 +98661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +98681,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 +98728,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +98766,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 +98785,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +98817,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 +98834,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +99174,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 +99351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80201,7 +99394,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +99414,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 +99461,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +99499,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 +99518,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +99550,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 +99567,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +100082,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 +100340,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80990,7 +100383,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +100404,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 +100451,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 +100490,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 +100509,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 +100542,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 +100559,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +100933,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 +101110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81588,7 +101153,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +101173,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 +101220,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +101258,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 +101277,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +101309,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 +101326,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +101666,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 +101843,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82151,7 +101886,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +101906,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 +101953,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +101991,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 +102010,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +102042,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 +102059,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +102478,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 +102652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82785,7 +102695,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +102716,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 +102763,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 +102802,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 +102821,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 +102854,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 +102871,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +103214,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 +103391,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83352,7 +103434,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +103454,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 +103501,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +103539,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 +103558,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +103590,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 +103607,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +104009,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 +104159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83950,7 +104202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104223,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 +104270,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 +104309,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 +104328,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 +104361,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 +104378,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +104762,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 +104912,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84531,7 +104955,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104976,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 +105023,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 +105062,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 +105081,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 +105114,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 +105131,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +105453,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 +105630,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85077,7 +105673,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +105693,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 +105740,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +105778,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 +105797,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +105829,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 +105846,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +106186,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 +106363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85640,7 +106406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +106426,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 +106473,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +106511,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 +106530,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +106562,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 +106579,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +106919,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 +107096,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86203,7 +107139,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +107159,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 +107206,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +107244,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 +107263,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +107295,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 +107312,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +108022,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 +108306,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87242,7 +108349,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +108371,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 +108418,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 +108458,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 +108477,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 +108511,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 +108528,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +108937,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 +109114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87876,7 +109157,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +109177,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 +109224,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +109262,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 +109281,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +109313,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 +109330,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +110183,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": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "beginDate", + "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 +110521,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89068,7 +110564,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +110586,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 +110633,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 +110673,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 +110692,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 +110726,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 +110743,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +111167,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 +111344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89717,7 +111387,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +111407,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 +111454,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +111492,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 +111511,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +111543,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 +111560,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +112059,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 +112266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90459,7 +112309,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +112332,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 +112379,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 +112420,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 +112439,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 +112474,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 +112491,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +112849,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 +113026,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91043,7 +113069,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +113089,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 +113136,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +113174,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 +113193,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +113225,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 +113242,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +114514,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 +114705,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92547,7 +114748,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +114770,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 +114817,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 +114857,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 +114876,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 +114910,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 +114927,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +115290,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 +115467,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93135,7 +115510,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +115530,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 +115577,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +115615,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 +115634,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +115666,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 +115683,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +116023,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 +116200,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93698,7 +116243,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +116263,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 +116310,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +116348,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 +116367,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +116399,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 +116416,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +116756,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 +116933,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94261,7 +116976,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +116996,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 +117043,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +117081,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 +117100,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +117132,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 +117149,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +117489,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 +117666,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94824,7 +117709,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +117729,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 +117776,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +117814,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 +117833,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +117865,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 +117882,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +118222,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 +118399,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95387,7 +118442,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +118462,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 +118509,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +118547,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 +118566,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +118598,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 +118615,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +118955,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 +119132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95950,7 +119175,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +119195,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 +119242,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +119280,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 +119299,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +119331,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 +119348,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +119688,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 +119865,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96513,7 +119908,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +119928,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 +119975,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +120013,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 +120032,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +120064,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 +120081,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +120421,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 +120598,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97076,7 +120641,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +120661,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 +120708,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +120746,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 +120765,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +120797,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 +120814,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +121154,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 +121331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97639,7 +121374,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +121394,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 +121441,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +121479,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 +121498,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +121530,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 +121547,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +121887,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 +122064,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98202,7 +122107,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +122127,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 +122174,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +122212,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 +122231,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +122263,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 +122280,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +122620,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 +122797,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98765,7 +122840,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +122860,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 +122907,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +122945,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 +122964,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +122996,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 +123013,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +123353,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 +123530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99328,7 +123573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +123593,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 +123640,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +123678,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 +123697,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +123729,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 +123746,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +124086,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 +124263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99891,7 +124306,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +124326,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 +124373,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +124411,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 +124430,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +124462,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 +124479,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +124819,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 +124996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100454,7 +125039,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +125059,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 +125106,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +125144,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 +125163,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +125195,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 +125212,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +125552,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 +125729,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101017,7 +125772,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +125792,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 +125839,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +125877,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 +125896,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +125928,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 +125945,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +126285,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 +126462,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101580,7 +126505,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +126525,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 +126572,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +126610,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 +126629,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +126661,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 +126678,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +127018,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 +127195,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102143,7 +127238,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +127258,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 +127305,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +127343,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 +127362,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +127394,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 +127411,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +128238,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 +128425,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103203,7 +128468,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +128489,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 +128536,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 +128575,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 +128594,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 +128627,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 +128644,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +129629,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 +129817,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104423,7 +129860,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +129881,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 +129928,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 +129967,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 +129986,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 +130019,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 +130036,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +131128,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 +131333,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105767,7 +131376,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +131398,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 +131445,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 +131485,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 +131504,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 +131538,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 +131555,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +131923,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 +132100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106360,7 +132143,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +132163,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 +132210,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +132248,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 +132267,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +132299,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 +132316,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +132656,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 +132833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106923,7 +132876,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +132896,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 +132943,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +132981,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 +133000,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +133032,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 +133049,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +133389,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 +133566,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107486,7 +133609,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +133629,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 +133676,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +133714,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 +133733,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +133765,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 +133782,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +134122,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 +134299,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108049,7 +134342,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +134362,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 +134409,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +134447,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 +134466,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +134498,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 +134515,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +134957,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 +135142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108716,7 +135185,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +135205,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 +135252,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +135290,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 +135309,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +135341,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 +135358,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +135704,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 +135881,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109285,7 +135924,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +135944,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 +135991,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +136029,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 +136048,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +136080,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 +136097,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +136437,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 +136614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109848,7 +136657,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +136677,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 +136724,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +136762,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 +136781,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +136813,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 +136830,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +137767,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 +137977,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111046,7 +138020,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +138047,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 +138094,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 +138139,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 +138158,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 +138197,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 +138214,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +138592,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 +138769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111654,7 +138812,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +138832,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 +138879,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +138917,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 +138936,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +138968,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 +138985,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +139325,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 +139502,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112217,7 +139545,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +139565,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 +139612,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +139650,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 +139669,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +139701,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 +139718,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +140058,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 +140235,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112780,7 +140278,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +140298,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 +140345,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +140383,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 +140402,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +140434,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 +140451,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +140791,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 +140968,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113343,7 +141011,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +141031,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 +141078,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +141116,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 +141135,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +141167,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 +141184,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +141713,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 +141898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114098,7 +141941,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +141962,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 +142009,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 +142048,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 +142067,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 +142100,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 +142117,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +142553,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": [ + "asOfDate", + "accountIdentifier", + "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 +142742,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114760,7 +142785,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +142806,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 +142853,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 +142892,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 +142911,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 +142944,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 +142961,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +143392,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": [ + "asOfDate", + "accountIdentifier", + "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 +143581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115417,7 +143624,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +143645,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 +143692,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 +143731,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 +143750,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 +143783,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 +143800,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +144275,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": [ + "asOfDate", + "accountIdentifier", + "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 +144479,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116128,7 +144522,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +144543,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 +144590,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 +144629,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 +144648,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 +144681,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 +144698,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +146582,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 +146793,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118275,7 +146836,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +146859,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 +146906,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 +146947,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 +146966,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 +147001,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 +147018,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +147402,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 +147579,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118885,7 +147622,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +147642,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 +147689,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +147727,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 +147746,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +147778,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 +147795,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +148222,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": [ + "asOfDate", + "accountIdentifier", + "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 +148411,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119537,7 +148454,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +148475,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 +148522,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 +148561,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 +148580,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 +148613,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 +148630,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +149105,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": [ + "asOfDate", + "accountIdentifier", + "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 +149309,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120248,7 +149352,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +149373,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 +149420,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 +149459,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 +149478,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 +149511,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 +149528,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +149879,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 +150056,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120823,7 +150099,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +150119,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 +150166,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +150204,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 +150223,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +150255,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 +150272,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +150649,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 +150808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121405,7 +150851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +150873,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 +150920,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 +150960,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 +150979,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 +151013,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 +151030,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +151364,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 +151541,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121964,7 +151584,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +151604,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 +151651,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +151689,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 +151708,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +151740,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 +151757,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +152097,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 +152274,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122527,7 +152317,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +152337,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 +152384,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +152422,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 +152441,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +152473,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 +152490,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +152830,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 +153007,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123090,7 +153050,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +153070,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 +153117,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +153155,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 +153174,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +153206,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 +153223,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +153563,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 +153740,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123653,7 +153783,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +153803,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 +153850,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +153888,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 +153907,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +153939,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 +153956,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +154296,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 +154473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124216,7 +154516,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +154536,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 +154583,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +154621,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 +154640,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +154672,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 +154689,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +155029,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 +155206,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124779,7 +155249,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +155269,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 +155316,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +155354,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 +155373,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +155405,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 +155422,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +155762,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 +155939,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125342,7 +155982,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +156002,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 +156049,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +156087,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 +156106,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +156138,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 +156155,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +156495,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 +156672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125905,7 +156715,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +156735,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 +156782,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +156820,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 +156839,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +156871,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 +156888,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +157228,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 +157405,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126468,7 +157448,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +157468,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 +157515,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +157553,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 +157572,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +157604,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 +157621,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +157961,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 +158138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127031,7 +158181,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +158201,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 +158248,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +158286,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 +158305,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +158337,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 +158354,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +158756,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 +158906,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127629,7 +158949,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +158970,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 +159017,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 +159056,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 +159075,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 +159108,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 +159125,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +160062,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", + "namespace", + "identificationCode" + ], + "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 +160275,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128820,7 +160318,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +160340,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 +160387,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 +160427,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 +160446,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 +160480,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 +160497,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +161118,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 +161322,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129693,7 +161365,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +161386,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 +161433,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 +161472,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 +161491,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 +161524,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 +161541,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +161903,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 +162080,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130279,7 +162123,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +162143,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 +162190,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +162228,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 +162247,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +162279,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 +162296,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +162698,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 +162848,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130877,7 +162891,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +162912,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 +162959,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 +162998,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 +163017,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 +163050,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 +163067,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +164482,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 +164664,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132526,7 +164707,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +164728,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 +164775,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 +164814,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 +164833,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 +164866,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 +164883,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +165245,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 +165422,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133112,7 +165465,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +165485,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 +165532,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +165570,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 +165589,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +165621,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 +165638,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +165978,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 +166155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133675,7 +166198,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +166218,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 +166265,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +166303,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 +166322,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +166354,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 +166371,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +166711,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 +166888,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134238,7 +166931,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +166951,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 +166998,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +167036,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 +167055,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +167087,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 +167104,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +167430,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 +167571,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134751,7 +167614,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +167636,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 +167793,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +167825,6 @@ }, { "$ref": "#/components/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 +167851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134932,7 +167908,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +168110,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 +168287,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135293,7 +168330,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +168350,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 +168503,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +168535,6 @@ }, { "$ref": "#/components/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 +168561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135472,7 +168618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +168843,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 +169020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135856,7 +169063,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +169083,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 +169130,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +169168,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 +169187,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +169219,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 +169236,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +169576,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 +169753,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136419,7 +169796,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +169816,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 +169863,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +169901,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 +169920,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +169952,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 +169969,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +170309,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 +170486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136982,7 +170529,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +170549,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 +170596,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +170634,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 +170653,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +170685,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 +170702,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +171042,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 +171219,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137545,7 +171262,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +171282,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 +171329,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +171367,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 +171386,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +171418,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 +171435,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +171775,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 +171952,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138108,7 +171995,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +172015,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 +172062,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +172100,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 +172119,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +172151,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 +172168,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +172571,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 +172737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138718,7 +172780,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +172801,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 +172848,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 +172887,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 +172906,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 +172939,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 +172956,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +173285,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 +173462,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139271,7 +173505,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +173525,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 +173572,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +173610,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 +173629,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +173661,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 +173678,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +175154,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 +175335,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -140979,7 +175378,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +175400,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 +175447,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 +175487,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 +175506,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 +175540,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 +175557,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +175919,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 +176096,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141566,7 +176139,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +176159,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 +176206,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +176244,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 +176263,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +176295,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 +176312,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +176652,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 +176829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142129,7 +176872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +176892,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 +176939,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +176977,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 +176996,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +177028,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 +177045,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +177385,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 +177562,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142692,7 +177605,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +177625,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 +177672,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +177710,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 +177729,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +177761,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 +177778,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +178118,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 +178295,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143255,7 +178338,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +178358,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 +178405,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +178443,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 +178462,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +178494,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 +178511,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +178851,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 +179028,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143818,7 +179071,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +179091,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 +179138,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +179176,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 +179195,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +179227,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 +179244,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +179584,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 +179761,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144381,7 +179804,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +179824,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 +179871,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +179909,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 +179928,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +179960,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 +179977,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +180317,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 +180494,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144944,7 +180537,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +180557,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 +180604,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +180642,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 +180661,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +180693,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 +180710,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +181112,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 +181262,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145542,7 +181305,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +181326,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 +181373,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 +181412,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 +181431,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 +181464,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 +181481,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +182209,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": [ + "programEvaluationElementTitle", + "programEducationOrganizationId", + "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 +182471,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146554,7 +182514,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +182535,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 +182582,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 +182621,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 +182640,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 +182673,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 +182690,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +183356,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": [ + "programEvaluationObjectiveTitle", + "programEducationOrganizationId", + "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 +183608,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147494,7 +183651,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +183672,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 +183719,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 +183758,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 +183777,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 +183810,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 +183827,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +184208,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 +184385,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148099,7 +184428,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +184448,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 +184495,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +184533,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 +184552,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +184584,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 +184601,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +184941,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 +185118,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148662,7 +185161,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +185181,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 +185228,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +185266,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 +185285,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +185317,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 +185334,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +185938,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": [ + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programEducationOrganizationId", + "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 +186166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149520,7 +186209,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +186230,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 +186277,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 +186316,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 +186335,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 +186368,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 +186385,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +186753,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 +186930,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150112,7 +186973,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +186993,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 +187040,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +187078,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 +187097,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +187129,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 +187146,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +187486,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 +187663,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150675,7 +187706,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +187726,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 +187773,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +187811,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 +187830,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +187862,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 +187879,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +188450,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 +188615,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151452,7 +188658,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +188690,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 +188737,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 +188787,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 +188806,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 +188850,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 +188867,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +189216,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 +189393,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152036,7 +189436,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +189456,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 +189503,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +189541,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 +189560,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +189592,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 +189609,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +189949,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 +190126,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152599,7 +190169,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +190189,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 +190236,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +190274,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 +190293,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +190325,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 +190342,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +190744,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 +190894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153197,7 +190937,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +190958,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 +191005,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 +191044,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 +191063,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 +191096,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 +191113,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +191435,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 +191612,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153743,7 +191655,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +191675,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 +191722,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +191760,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 +191779,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +191811,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 +191828,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +192168,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 +192345,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154306,7 +192388,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +192408,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 +192455,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +192493,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 +192512,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +192544,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 +192561,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +192901,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 +193078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154869,7 +193121,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +193141,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 +193188,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +193226,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 +193245,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +193277,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 +193294,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +193634,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 +193811,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155432,7 +193854,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +193874,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 +193921,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +193959,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 +193978,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +194010,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 +194027,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +194367,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 +194544,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155995,7 +194587,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +194607,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 +194654,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +194692,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 +194711,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +194743,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 +194760,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +195100,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 +195277,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156558,7 +195320,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +195340,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 +195387,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +195425,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 +195444,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +195476,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 +195493,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +195833,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 +196010,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157121,7 +196053,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +196073,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 +196120,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +196158,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 +196177,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +196209,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 +196226,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +196566,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 +196743,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157684,7 +196786,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +196806,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 +196853,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +196891,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 +196910,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +196942,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 +196959,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +197299,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 +197476,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158247,7 +197519,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +197539,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 +197586,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +197624,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 +197643,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +197675,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 +197692,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +198032,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 +198209,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158810,7 +198252,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +198272,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 +198319,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +198357,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 +198376,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +198408,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 +198425,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +198765,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 +198942,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159373,7 +198985,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +199005,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 +199052,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +199090,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 +199109,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +199141,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 +199158,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +199498,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 +199675,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159936,7 +199718,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +199738,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 +199785,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +199823,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 +199842,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +199874,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 +199891,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +200911,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 +201139,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161210,7 +201182,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +201204,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 +201251,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 +201291,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 +201310,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 +201344,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 +201361,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +201730,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 +201907,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161804,7 +201950,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +201970,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 +202017,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +202055,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 +202074,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +202106,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 +202123,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +202463,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 +202640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162367,7 +202683,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +202703,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 +202750,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +202788,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 +202807,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +202839,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 +202856,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +203196,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 +203373,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162930,7 +203416,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +203436,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 +203483,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +203521,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 +203540,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +203572,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 +203589,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +203929,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 +204106,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163493,7 +204149,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +204169,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 +204216,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +204254,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 +204273,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +204305,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 +204322,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +204662,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 +204839,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164056,7 +204882,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +204902,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 +204949,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +204987,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 +205006,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +205038,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 +205055,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +205395,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 +205572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164619,7 +205615,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +205635,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 +205682,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +205720,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 +205739,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +205771,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 +205788,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +206402,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 +206586,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165458,7 +206629,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +206650,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 +206697,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 +206736,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 +206755,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 +206788,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 +206805,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +207155,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 +207332,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166032,7 +207375,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +207395,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 +207442,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +207480,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 +207499,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +207531,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 +207548,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +207888,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 +208065,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166595,7 +208108,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +208128,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 +208175,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +208213,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 +208232,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +208264,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 +208281,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +208621,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 +208798,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167158,7 +208841,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +208861,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 +208908,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +208946,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 +208965,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +208997,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 +209014,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +209354,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 +209531,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167721,7 +209574,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +209594,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 +209641,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +209679,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 +209698,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +209730,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 +209747,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +210087,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 +210264,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168284,7 +210307,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +210327,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 +210374,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +210412,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 +210431,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +210463,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 +210480,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +210820,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 +210997,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168847,7 +211040,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +211060,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 +211107,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +211145,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 +211164,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +211196,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 +211213,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +211553,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 +211730,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169410,7 +211773,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +211793,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 +211840,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +211878,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 +211897,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +211929,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 +211946,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +212255,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 +212396,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169911,7 +212439,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +212459,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 +212612,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +212644,6 @@ }, { "$ref": "#/components/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 +212670,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170090,7 +212727,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +214312,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 +214557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171907,7 +214600,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +214634,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 +214815,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +214847,6 @@ }, { "$ref": "#/components/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 +214873,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172100,7 +214930,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +215233,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 +215410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172562,7 +215453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +215473,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 +215520,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +215558,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 +215577,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +215609,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 +215626,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +216171,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 +216406,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173363,7 +216449,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +216470,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 +216517,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 +216556,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 +216575,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 +216608,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 +216625,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +216991,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 +217168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173953,7 +217211,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +217231,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 +217278,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +217316,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 +217335,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +217367,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 +217384,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +217724,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 +217901,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174516,7 +217944,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +217964,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 +218011,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +218049,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 +218068,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +218100,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 +218117,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +219178,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", + "sessionName", + "sectionIdentifier" + ], + "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 +219482,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175912,7 +219525,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +219558,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 +219605,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 +219656,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 +219675,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 +219720,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 +219737,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +220173,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 +220350,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176584,7 +220393,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +220413,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 +220460,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +220498,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 +220517,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +220549,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 +220566,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +220906,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 +221083,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177147,7 +221126,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +221146,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 +221193,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +221231,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 +221250,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +221282,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 +221299,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +221639,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 +221816,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177710,7 +221859,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +221879,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 +221926,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +221964,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 +221983,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +222015,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 +222032,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +222695,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 +222887,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178606,7 +222930,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +222958,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 +223005,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 +223051,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 +223070,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 +223110,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 +223127,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +223485,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 +223662,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179195,7 +223705,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +223725,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 +223772,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +223810,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 +223829,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +223861,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 +223878,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +224280,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 +224430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179793,7 +224473,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +224494,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 +224541,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 +224580,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 +224599,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 +224632,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 +224649,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +224971,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 +225148,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180339,7 +225191,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +225211,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 +225258,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +225296,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 +225315,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +225347,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 +225364,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +225704,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 +225881,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180902,7 +225924,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +225944,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 +225991,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +226029,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 +226048,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +226080,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 +226097,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +226437,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 +226614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181465,7 +226657,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +226677,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 +226724,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +226762,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 +226781,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +226813,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 +226830,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +227170,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 +227347,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182028,7 +227390,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +227410,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 +227457,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +227495,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 +227514,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +227546,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 +227563,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +227973,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 +228147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182653,7 +228190,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +228211,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 +228258,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 +228297,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 +228316,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 +228349,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 +228366,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +228701,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 +228878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183212,7 +228921,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +228941,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 +228988,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +229026,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 +229045,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +229077,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 +229094,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +229532,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 +229720,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183874,7 +229763,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +229784,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 +229831,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 +229870,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 +229889,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 +229922,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 +229939,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +230374,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 +230530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184507,7 +230573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +230594,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 +230641,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 +230680,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 +230699,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 +230732,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 +230749,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +231348,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 +231605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185400,7 +231648,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +231670,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 +231717,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 +231757,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 +231776,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 +231810,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 +231827,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +232799,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 +232974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186590,7 +233017,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +233038,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 +233085,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 +233124,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 +233143,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 +233176,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 +233193,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +233818,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 +234081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187515,7 +234124,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +234145,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 +234192,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 +234231,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 +234250,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 +234283,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 +234300,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +234693,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 +234870,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188132,7 +234913,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +234933,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 +234980,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +235018,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 +235037,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +235069,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 +235086,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +235426,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 +235603,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188695,7 +235646,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +235666,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 +235713,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +235751,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 +235770,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +235802,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 +235819,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +236242,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 +236424,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189341,7 +236467,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +236488,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 +236535,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 +236574,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 +236593,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 +236626,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 +236643,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +237104,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 +237307,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190037,7 +237350,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +237374,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 +237421,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 +237463,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 +237482,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 +237518,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 +237535,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +238148,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 +238323,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190870,7 +238366,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +238389,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 +238436,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 +238477,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 +238496,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 +238531,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 +238548,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +239115,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 +239374,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191720,7 +239417,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +239441,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 +239488,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 +239530,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 +239549,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 +239585,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 +239602,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +242445,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 +242763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194936,7 +242806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +242837,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 +242884,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 +242933,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 +242952,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 +242995,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 +243012,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +243462,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 +243639,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195620,7 +243682,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +243702,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 +243749,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +243787,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 +243806,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +243838,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 +243855,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +245396,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 +245559,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197375,7 +245602,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +245624,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 +245671,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 +245711,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 +245730,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 +245764,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 +245781,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +247746,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 +248034,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199666,7 +248077,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +248101,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 +248148,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 +248190,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 +248209,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 +248245,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 +248262,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +248817,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": [ + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "assessmentIdentifier", + "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 +249029,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200462,7 +249072,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +249093,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 +249140,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 +249179,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 +249198,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 +249231,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 +249248,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +249805,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": [ + "assessmentBatteryPartName", + "administrationIdentifier", + "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 +250023,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201258,7 +250066,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +250087,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 +250134,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 +250173,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 +250192,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 +250225,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 +250242,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +251037,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", + "namespace", + "educationOrganizationId", + "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 +251318,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202360,7 +251361,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +251382,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 +251429,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 +251468,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 +251487,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 +251520,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 +251537,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +253206,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 +253515,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204374,7 +253558,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +253580,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 +253627,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 +253667,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 +253686,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 +253720,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 +253737,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +254648,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 +254900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205565,7 +254943,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +254964,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 +255011,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 +255050,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 +255069,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 +255102,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 +255119,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +255508,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 +255685,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206178,7 +255728,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +255748,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 +255795,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +255833,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 +255852,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +255884,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 +255901,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +256435,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 +256615,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206928,7 +256658,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +256680,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 +256727,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 +256767,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 +256786,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 +256820,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 +256837,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +257625,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", + "objectiveEducationOrganizationId", + "objective", + "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 +257874,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207983,7 +257917,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +257939,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 +257986,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 +258026,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 +258045,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 +258079,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 +258096,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +258608,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 +258808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208743,7 +258851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +258872,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 +258919,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 +258958,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 +258977,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 +259010,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 +259027,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +259567,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 +259759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209512,7 +259802,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +259823,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 +259870,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 +259909,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 +259928,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 +259961,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 +259978,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +260405,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 +260561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210137,7 +260604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +260625,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 +260672,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 +260711,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 +260730,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 +260763,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 +260780,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +261175,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 +261316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210720,7 +261359,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +261380,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 +261427,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 +261466,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 +261485,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 +261518,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 +261535,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +264086,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 +264363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213595,7 +264406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +264428,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 +264475,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 +264515,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 +264534,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 +264568,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 +264585,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +265084,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 +265264,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214312,7 +265307,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +265328,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 +265375,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 +265414,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 +265433,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 +265466,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 +265483,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +266040,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 +266278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215148,7 +266321,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +266343,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 +266390,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 +266430,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 +266449,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 +266483,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 +266500,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +267196,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 +267364,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216060,7 +267407,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +267428,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 +267475,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 +267514,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 +267533,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 +267566,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 +267583,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +268388,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 +268640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217144,7 +268683,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +268704,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 +268751,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 +268790,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 +268809,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 +268842,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 +268859,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +269248,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 +269425,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217757,7 +269468,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +269488,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 +269535,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/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 +269573,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 +269592,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "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 +269624,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 +269641,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +270240,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 +270434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218591,7 +270477,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +270499,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 +270546,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 +270586,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 +270605,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 +270639,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 +270656,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +271191,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", + "eventDate", + "educationOrganizationId", + "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 +271413,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219381,7 +271456,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +271477,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 +271524,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 +271563,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 +271582,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 +271615,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 +271632,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +272589,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 +272833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220609,7 +272876,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +272897,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 +272944,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 +272983,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 +273002,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 +273035,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 +273052,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +274013,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 +274320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221904,7 +274363,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +274384,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 +274431,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 +274470,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 +274489,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 +274522,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 +274539,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +275432,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 +275686,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223078,7 +275729,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +275750,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 +275797,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 +275836,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 +275855,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 +275888,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 +275905,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +276705,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 +276932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224132,7 +276975,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +277002,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 +277049,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 +277094,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 +277113,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 +277152,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 +277169,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +277789,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 +278041,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225032,7 +278084,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +278107,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 +278154,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 +278195,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 +278214,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 +278249,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 +278266,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +279412,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 +279699,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226484,7 +279742,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +279763,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 +279810,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 +279849,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 +279868,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 +279901,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 +279918,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +281045,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 +281407,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228015,7 +281450,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +281475,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 +281522,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 +281565,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 +281584,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 +281621,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 +281638,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +282395,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 +282648,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229056,7 +282691,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +282714,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 +282761,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 +282802,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 +282821,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 +282856,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 +282873,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +283682,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 +283917,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230129,7 +283960,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +283981,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 +284028,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 +284067,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 +284086,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 +284119,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 +284136,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +284902,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 +285172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231192,7 +285215,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +285236,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 +285283,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 +285322,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 +285341,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 +285374,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 +285391,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +286213,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 +286516,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232339,7 +286559,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +286588,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 +286635,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 +286682,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 +286701,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 +286742,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 +286759,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +287542,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 +287825,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233430,7 +287868,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +287891,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 +287938,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 +287979,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 +287998,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 +288033,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 +288050,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +289471,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 +289829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235238,7 +289872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +289894,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 +289941,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 +289981,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 +290000,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 +290034,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 +290051,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +290928,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 +291262,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236477,7 +291305,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +291326,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 +291373,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 +291412,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 +291431,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 +291464,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 +291481,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +292348,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 +292584,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237607,7 +292627,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +292648,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 +292695,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 +292734,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 +292753,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 +292786,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 +292803,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +293418,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 +293611,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238462,7 +293654,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +293675,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 +293722,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 +293761,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 +293780,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 +293813,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 +293830,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +295049,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 +295348,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240032,7 +295391,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +295431,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 +295457,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 +295478,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 +296076,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 +296253,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240727,7 +296296,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +296316,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 +296469,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296501,6 @@ }, { "$ref": "#/components/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 +296527,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240906,7 +296584,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296809,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 +296986,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241290,7 +297029,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +297049,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 +297202,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297234,6 @@ }, { "$ref": "#/components/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 +297260,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241469,7 +297317,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297542,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 +297719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241853,7 +297762,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +297782,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 +297935,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297967,6 @@ }, { "$ref": "#/components/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 +297993,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242032,7 +298050,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298330,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 +298503,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242456,7 +298546,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +298567,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 +298722,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298754,6 @@ }, { "$ref": "#/components/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 +298780,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242636,7 +298837,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299055,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 +299232,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243013,7 +299275,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +299295,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 +299448,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299480,6 @@ }, { "$ref": "#/components/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 +299506,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243192,7 +299563,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299862,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", + "programName", + "programTypeDescriptor", + "namespace", + "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 +300050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243645,7 +300093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +300114,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 +300269,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300301,6 @@ }, { "$ref": "#/components/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 +300327,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243825,7 +300384,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300976,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 +301166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244578,7 +301209,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +301230,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 +301385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301417,6 @@ }, { "$ref": "#/components/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 +301443,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244758,7 +301500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302046,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": [ + "questionCode", + "namespace", + "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 +302232,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245466,7 +302275,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +302296,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 +302451,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302483,6 @@ }, { "$ref": "#/components/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 +302509,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245646,7 +302566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302848,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 +303021,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246072,7 +303064,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +303085,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 +303240,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303272,6 @@ }, { "$ref": "#/components/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 +303298,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246252,7 +303355,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303628,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": [ + "staffUniqueId", + "namespace", + "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 +303801,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246669,7 +303844,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +303865,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 +304020,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304052,6 @@ }, { "$ref": "#/components/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 +304078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246849,7 +304135,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304610,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 +304844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247534,7 +304887,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +304908,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 +305063,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305095,6 @@ }, { "$ref": "#/components/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 +305121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247714,7 +305178,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305552,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", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "namespace", + "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 +305770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248262,7 +305813,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +305834,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 +305989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +306021,6 @@ }, { "$ref": "#/components/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 +306047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248442,7 +306104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +306425,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 +306613,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248917,7 +306656,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +306677,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 +306832,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +306864,6 @@ }, { "$ref": "#/components/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 +306890,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249097,7 +306947,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307256,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": [ + "staffUniqueId", + "namespace", + "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 +307444,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249560,7 +307487,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +307508,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 +307663,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307695,6 @@ }, { "$ref": "#/components/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 +307721,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249740,7 +307778,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308112,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": [ + "surveyResponseIdentifier", + "namespace", + "surveyIdentifier", + "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 +308294,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250227,7 +308337,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +308358,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 +308513,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308545,6 @@ }, { "$ref": "#/components/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 +308571,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250407,7 +308628,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308869,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 +309027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250782,7 +309070,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +309091,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 +309246,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309278,6 @@ }, { "$ref": "#/components/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 +309304,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250962,7 +309361,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309748,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 +309957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251539,7 +310000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +310021,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 +310176,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310208,6 @@ }, { "$ref": "#/components/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 +310234,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251719,7 +310291,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310535,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 +310712,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252122,7 +310755,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +310775,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 +310928,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310960,6 @@ }, { "$ref": "#/components/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 +310986,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252301,7 +311043,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +311268,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 +311445,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252685,7 +311488,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +311508,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 +311661,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +311693,6 @@ }, { "$ref": "#/components/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 +311719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252864,7 +311776,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312001,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 +312178,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253248,7 +312221,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +312241,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 +312394,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312426,6 @@ }, { "$ref": "#/components/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 +312452,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253427,7 +312509,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312734,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 +312911,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253811,7 +312954,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +312974,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 +313127,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +313159,6 @@ }, { "$ref": "#/components/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 +313185,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253990,7 +313242,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +313467,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 +313644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254374,7 +313687,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +313707,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 +313860,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +313892,6 @@ }, { "$ref": "#/components/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 +313918,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254553,7 +313975,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +314200,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 +314377,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254937,7 +314420,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +314440,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 +314593,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +314625,6 @@ }, { "$ref": "#/components/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 +314651,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255116,7 +314708,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +314933,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 +315110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255500,7 +315153,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +315173,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 +315326,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +315358,6 @@ }, { "$ref": "#/components/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 +315384,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255679,7 +315441,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +315666,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 +315843,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256063,7 +315886,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +315906,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 +316059,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +316091,6 @@ }, { "$ref": "#/components/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 +316117,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256242,7 +316174,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +316399,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 +316576,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256626,7 +316619,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +316639,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 +316792,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +316824,6 @@ }, { "$ref": "#/components/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 +316850,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256805,7 +316907,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +317132,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 +317309,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257189,7 +317352,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +317372,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 +317525,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +317557,6 @@ }, { "$ref": "#/components/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 +317583,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257368,7 +317640,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +317865,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 +318042,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257752,7 +318085,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +318105,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 +318258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +318290,6 @@ }, { "$ref": "#/components/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 +318316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257931,7 +318373,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +318598,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 +318775,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258315,7 +318818,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +318838,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 +318991,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +319023,6 @@ }, { "$ref": "#/components/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 +319049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258494,7 +319106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +319331,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 +319508,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258878,7 +319551,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +319571,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 +319724,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +319756,6 @@ }, { "$ref": "#/components/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 +319782,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259057,7 +319839,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +320064,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 +320241,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259441,7 +320284,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +320304,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 +320457,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +320489,6 @@ }, { "$ref": "#/components/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 +320515,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259620,7 +320572,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +320797,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 +320974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260004,7 +321017,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +321037,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 +321190,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +321222,6 @@ }, { "$ref": "#/components/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 +321248,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260183,7 +321305,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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..68f74efe9 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": { @@ -1209,9 +1269,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." }, @@ -1395,9 +1452,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 +2103,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 +2280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2208,7 +2323,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +2344,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 +2499,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2531,6 @@ }, { "$ref": "#/components/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 +2557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2388,7 +2614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2845,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 +3022,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2778,7 +3065,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +3090,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 +3137,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 +3180,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 +3199,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 +3236,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 +3253,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +3624,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 +3801,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3377,7 +3844,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +3890,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 +3916,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 +3937,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 +4524,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 +4694,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4047,7 +4737,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +4758,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 +4913,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +4945,6 @@ }, { "$ref": "#/components/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 +4971,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4227,7 +5028,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +5254,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 +5431,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4612,7 +5474,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +5497,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 +5656,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +5688,6 @@ }, { "$ref": "#/components/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 +5714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4794,7 +5771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +6000,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 +6177,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5182,7 +6220,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +6241,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 +6396,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +6428,6 @@ }, { "$ref": "#/components/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 +6454,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5362,7 +6511,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +6858,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 +7050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5878,7 +7093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +7115,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 +7272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +7304,6 @@ }, { "$ref": "#/components/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 +7330,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6059,7 +7387,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +7638,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 +7815,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6469,7 +7858,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +7893,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 +8076,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +8108,6 @@ }, { "$ref": "#/components/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 +8134,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6663,7 +8191,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +8431,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 +8608,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7062,7 +8651,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +8671,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 +8824,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +8856,6 @@ }, { "$ref": "#/components/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 +8882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7241,7 +8939,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +9168,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 +9345,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7629,7 +9388,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +9412,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 +9573,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +9605,6 @@ }, { "$ref": "#/components/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 +9631,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7812,7 +9688,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +9941,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 +10118,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8224,7 +10161,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +10205,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 +10406,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +10438,6 @@ }, { "$ref": "#/components/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 +10464,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8427,7 +10521,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +10772,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 +10949,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8837,7 +10992,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +11014,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 +11171,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +11203,6 @@ }, { "$ref": "#/components/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 +11229,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9018,7 +11286,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +11527,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 +11704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9418,7 +11747,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +11781,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 +11962,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +11994,6 @@ }, { "$ref": "#/components/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 +12020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9611,7 +12077,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +12317,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 +12494,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10010,7 +12537,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +12558,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 +12713,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +12745,6 @@ }, { "$ref": "#/components/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 +12771,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10190,7 +12828,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +13067,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 +13244,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10588,7 +13287,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +13320,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 +13499,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +13531,6 @@ }, { "$ref": "#/components/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 +13557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10780,7 +13614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +16225,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 +16521,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13673,7 +16564,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +16585,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 +16740,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +16772,6 @@ }, { "$ref": "#/components/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 +16798,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13853,7 +16855,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +17173,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 +17350,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14330,7 +17393,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +17414,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 +17569,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +17601,6 @@ }, { "$ref": "#/components/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 +17627,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14510,7 +17684,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +17911,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 +18088,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14896,7 +18131,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +18152,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 +18307,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +18339,6 @@ }, { "$ref": "#/components/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 +18365,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15076,7 +18422,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +18873,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": [ + "applicationEventTypeDescriptor", + "applicantProfileIdentifier", + "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 +19123,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15737,7 +19166,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +19187,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 +19342,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +19374,6 @@ }, { "$ref": "#/components/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 +19400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15917,7 +19457,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +19717,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 +19894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16336,7 +19937,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +19958,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 +20113,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +20145,6 @@ }, { "$ref": "#/components/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 +20171,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16516,7 +20228,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +20455,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 +20632,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16902,7 +20675,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +20696,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 +20851,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +20883,6 @@ }, { "$ref": "#/components/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 +20909,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17082,7 +20966,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +21787,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 +22064,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18155,7 +22107,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +22128,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 +22283,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +22315,6 @@ }, { "$ref": "#/components/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 +22341,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18335,7 +22398,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +22911,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 +23099,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19002,7 +23142,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +23163,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 +23318,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +23350,6 @@ }, { "$ref": "#/components/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 +23376,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19182,7 +23433,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +23890,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", + "namespace", + "assigningEducationOrganizationId" + ], + "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 +24063,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19783,7 +24106,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +24127,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 +24282,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +24314,6 @@ }, { "$ref": "#/components/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 +24340,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19963,7 +24397,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +24736,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 +24894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20436,7 +24937,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +24958,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 +25113,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +25145,6 @@ }, { "$ref": "#/components/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 +25171,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20616,7 +25228,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +25439,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 +25616,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20986,7 +25659,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +25681,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 +25838,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +25870,6 @@ }, { "$ref": "#/components/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 +25896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21167,7 +25953,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +26182,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 +26359,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21555,7 +26402,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +26424,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 +26581,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +26613,6 @@ }, { "$ref": "#/components/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 +26639,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21736,7 +26696,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +26925,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 +27102,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22124,7 +27145,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +27167,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 +27324,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +27356,6 @@ }, { "$ref": "#/components/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 +27382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22305,7 +27439,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +27668,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 +27845,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22693,7 +27888,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +27910,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 +28067,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +28099,6 @@ }, { "$ref": "#/components/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 +28125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22874,7 +28182,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +28699,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", + "namespace", + "identificationCode" + ], + "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 +28912,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23580,7 +28955,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +28977,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 +29134,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +29166,6 @@ }, { "$ref": "#/components/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 +29192,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23761,7 +29249,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +29497,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 +29674,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24168,7 +29717,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +29740,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 +29899,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +29931,6 @@ }, { "$ref": "#/components/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 +29957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24350,7 +30014,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +30246,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 +30423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24741,7 +30466,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +30490,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 +30651,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +30683,6 @@ }, { "$ref": "#/components/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 +30709,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24924,7 +30766,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +31208,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 +31403,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25537,7 +31446,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +31467,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 +31622,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +31654,6 @@ }, { "$ref": "#/components/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 +31680,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25717,7 +31737,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +33244,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 +33486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27447,7 +33529,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +33551,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 +33708,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +33740,6 @@ }, { "$ref": "#/components/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 +33766,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27628,7 +33823,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +34103,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 +34280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28067,7 +34323,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +34345,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 +34502,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +34534,6 @@ }, { "$ref": "#/components/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 +34560,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28248,7 +34617,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +34853,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 +35030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28643,7 +35073,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +35102,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 +35273,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +35305,6 @@ }, { "$ref": "#/components/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 +35331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28831,7 +35388,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +35626,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 +35803,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29228,7 +35846,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +35870,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 +36031,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +36063,6 @@ }, { "$ref": "#/components/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 +36089,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29411,7 +36146,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +36378,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 +36555,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29802,7 +36598,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +36621,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 +36780,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +36812,6 @@ }, { "$ref": "#/components/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 +36838,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29984,7 +36895,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +37126,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 +37303,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30374,7 +37346,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +37369,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 +37528,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +37560,6 @@ }, { "$ref": "#/components/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 +37586,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30556,7 +37643,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +37933,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 +38083,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30978,7 +38126,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +38147,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 +38302,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +38334,6 @@ }, { "$ref": "#/components/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 +38360,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31158,7 +38417,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +38626,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 +38803,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31526,7 +38846,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +38868,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 +39025,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +39057,6 @@ }, { "$ref": "#/components/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 +39083,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31707,7 +39140,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +39368,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 +39545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32094,7 +39588,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +39609,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 +39764,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +39796,6 @@ }, { "$ref": "#/components/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 +39822,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32274,7 +39879,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +40365,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 +40540,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32917,7 +40583,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +40604,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 +40759,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +40791,6 @@ }, { "$ref": "#/components/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 +40817,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33097,7 +40874,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +41104,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 +41281,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33486,7 +41324,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +41345,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 +41500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +41532,6 @@ }, { "$ref": "#/components/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 +41558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33666,7 +41615,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +41939,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", + "schoolId", + "schoolYear", + "date" + ], + "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 +42110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34133,7 +42153,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +42174,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 +42329,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +42361,6 @@ }, { "$ref": "#/components/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 +42387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34313,7 +42444,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +42662,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 +42839,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34690,7 +42882,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +42903,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 +43058,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +43090,6 @@ }, { "$ref": "#/components/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 +43116,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34870,7 +43173,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +43400,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 +43577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35256,7 +43620,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +43641,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 +43796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +43828,6 @@ }, { "$ref": "#/components/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 +43854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35436,7 +43911,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +44259,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 +44424,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35926,7 +44467,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +44488,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 +44643,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +44675,6 @@ }, { "$ref": "#/components/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 +44701,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36106,7 +44758,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +44976,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 +45153,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36483,7 +45196,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +45217,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 +45372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +45404,6 @@ }, { "$ref": "#/components/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 +45430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36663,7 +45487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +46300,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 +46539,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37680,7 +46582,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +46603,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 +46758,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +46790,6 @@ }, { "$ref": "#/components/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 +46816,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37860,7 +46873,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +47210,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 +47386,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38349,7 +47429,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +47450,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 +47605,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +47637,6 @@ }, { "$ref": "#/components/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 +47663,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38529,7 +47720,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +47944,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 +48121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38912,7 +48164,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +48185,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 +48340,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +48372,6 @@ }, { "$ref": "#/components/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 +48398,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39092,7 +48455,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +48756,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 +48926,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39544,7 +48969,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +48990,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 +49145,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +49177,6 @@ }, { "$ref": "#/components/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 +49203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39724,7 +49260,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +52252,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 +52660,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43110,7 +52703,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +52724,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 +52879,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +52911,6 @@ }, { "$ref": "#/components/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 +52937,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43290,7 +52994,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +53392,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 +53569,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43847,7 +53612,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +53639,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 +53806,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +53838,6 @@ }, { "$ref": "#/components/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 +53864,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44033,7 +53921,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +54387,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 +54651,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44729,7 +54694,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +54715,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 +54870,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +54902,6 @@ }, { "$ref": "#/components/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 +54928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44909,7 +54985,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +55260,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 +55437,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45343,7 +55480,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +55501,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 +55656,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +55688,6 @@ }, { "$ref": "#/components/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 +55714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45523,7 +55771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +55998,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 +56175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45909,7 +56218,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +56239,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 +56394,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +56426,6 @@ }, { "$ref": "#/components/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 +56452,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46089,7 +56509,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +56836,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 +57026,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46587,7 +57069,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +57090,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 +57245,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +57277,6 @@ }, { "$ref": "#/components/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 +57303,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46767,7 +57360,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +57593,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 +57770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47159,7 +57813,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +57834,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 +57989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +58021,6 @@ }, { "$ref": "#/components/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 +58047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47339,7 +58104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +58331,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 +58508,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47725,7 +58551,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +58572,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 +58727,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +58759,6 @@ }, { "$ref": "#/components/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 +58785,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47905,7 +58842,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +59072,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 +59249,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48294,7 +59292,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +59316,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 +59477,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +59509,6 @@ }, { "$ref": "#/components/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 +59535,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48477,7 +59592,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +59822,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 +59999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48866,7 +60042,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +60063,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 +60218,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +60250,6 @@ }, { "$ref": "#/components/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 +60276,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49046,7 +60333,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +60972,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 +61216,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49910,7 +61259,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +61280,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 +61435,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +61467,6 @@ }, { "$ref": "#/components/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 +61493,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50090,7 +61550,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +62387,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 +62641,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51158,7 +62684,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +62705,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 +62860,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +62892,6 @@ }, { "$ref": "#/components/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 +62918,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51338,7 +62975,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +63272,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 +63449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51794,7 +63492,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +63526,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 +63707,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +63739,6 @@ }, { "$ref": "#/components/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 +63765,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51987,7 +63822,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +64075,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 +64252,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52399,7 +64295,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +64329,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 +64510,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +64542,6 @@ }, { "$ref": "#/components/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 +64568,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52592,7 +64625,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +64888,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 +65065,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53014,7 +65108,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +65152,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 +65353,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +65385,6 @@ }, { "$ref": "#/components/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 +65411,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53217,7 +65468,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +65806,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 +65955,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53686,7 +65998,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +66021,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 +66180,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +66212,6 @@ }, { "$ref": "#/components/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 +66238,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53868,7 +66295,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +66513,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 +66690,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54245,7 +66733,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +66757,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 +66918,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +66950,6 @@ }, { "$ref": "#/components/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 +66976,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54428,7 +67033,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +67264,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 +67441,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54818,7 +67484,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +67506,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 +67663,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +67695,6 @@ }, { "$ref": "#/components/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 +67721,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54999,7 +67778,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +68007,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 +68184,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55387,7 +68227,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +68249,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 +68406,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +68438,6 @@ }, { "$ref": "#/components/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 +68464,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55568,7 +68521,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +68751,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 +68928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55957,7 +68971,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +68994,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 +69153,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +69185,6 @@ }, { "$ref": "#/components/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 +69211,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56139,7 +69268,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +69663,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 +69840,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56693,7 +69883,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +69905,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 +70062,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +70094,6 @@ }, { "$ref": "#/components/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 +70120,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56874,7 +70177,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +71113,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 +71538,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58222,7 +71581,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +71602,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 +71757,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +71789,6 @@ }, { "$ref": "#/components/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 +71815,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58402,7 +71872,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +72290,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 +72518,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59025,7 +72561,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +72582,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 +72737,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +72769,6 @@ }, { "$ref": "#/components/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 +72795,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59205,7 +72852,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +73945,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 +74423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60763,7 +74466,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +74487,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 +74642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +74674,6 @@ }, { "$ref": "#/components/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 +74700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60943,7 +74757,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +75034,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 +75211,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61379,7 +75254,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +75282,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 +75451,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +75483,6 @@ }, { "$ref": "#/components/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 +75509,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61566,7 +75566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +75883,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 +76066,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62043,7 +76109,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +76131,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 +76288,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +76320,6 @@ }, { "$ref": "#/components/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 +76346,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62224,7 +76403,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +76715,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 +76889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62687,7 +76932,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +76953,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 +77108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +77140,6 @@ }, { "$ref": "#/components/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 +77166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62867,7 +77223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +77448,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 +77625,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63251,7 +77668,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +77689,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 +77844,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +77876,6 @@ }, { "$ref": "#/components/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 +77902,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63431,7 +77959,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +79699,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 +79953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65412,7 +79996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +80018,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 +80175,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +80207,6 @@ }, { "$ref": "#/components/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 +80233,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65593,7 +80290,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +80579,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 +80756,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66041,7 +80799,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +80819,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 +80972,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +81004,6 @@ }, { "$ref": "#/components/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 +81030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66220,7 +81087,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +81313,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 +81490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66605,7 +81533,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +81554,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 +81709,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +81741,6 @@ }, { "$ref": "#/components/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 +81767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66785,7 +81824,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +82051,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 +82228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67171,7 +82271,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +82292,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 +82447,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +82479,6 @@ }, { "$ref": "#/components/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 +82505,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67351,7 +82562,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +82789,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 +82966,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67737,7 +83009,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +83030,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 +83185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +83217,6 @@ }, { "$ref": "#/components/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 +83243,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67917,7 +83300,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +83553,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 +83730,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68329,7 +83773,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +83820,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 +84027,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +84059,6 @@ }, { "$ref": "#/components/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 +84085,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68535,7 +84142,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +84398,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 +84575,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68950,7 +84618,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +84642,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 +84803,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +84835,6 @@ }, { "$ref": "#/components/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 +84861,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69133,7 +84918,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +85154,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 +85331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69528,7 +85374,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +85401,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 +85568,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +85600,6 @@ }, { "$ref": "#/components/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 +85626,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69714,7 +85683,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +85922,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 +86099,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70112,7 +86142,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86169,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 +86336,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +86368,6 @@ }, { "$ref": "#/components/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 +86394,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70298,7 +86451,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +86690,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 +86867,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70696,7 +86910,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86937,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 +87104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +87136,6 @@ }, { "$ref": "#/components/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 +87162,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70882,7 +87219,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +87466,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 +87643,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71288,7 +87686,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +87721,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 +87904,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +87936,6 @@ }, { "$ref": "#/components/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 +87962,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71482,7 +88019,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +88595,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 +88804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72239,7 +88847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +88871,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 +89032,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +89064,6 @@ }, { "$ref": "#/components/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 +89090,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72422,7 +89147,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +89399,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 +89576,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72833,7 +89619,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +89643,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 +89804,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +89836,6 @@ }, { "$ref": "#/components/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 +89862,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73016,7 +89919,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +91319,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 +91700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74754,7 +91743,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +91767,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 +91928,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +91960,6 @@ }, { "$ref": "#/components/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 +91986,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74937,7 +92043,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +93141,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 +93425,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76301,7 +93468,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +93495,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 +93662,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +93694,6 @@ }, { "$ref": "#/components/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 +93720,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76487,7 +93777,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +94091,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 +94268,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76960,7 +94311,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +94332,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 +94487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +94519,6 @@ }, { "$ref": "#/components/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 +94545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77140,7 +94602,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +94894,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 +95074,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77584,7 +95117,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +95138,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 +95293,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +95325,6 @@ }, { "$ref": "#/components/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 +95351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77764,7 +95408,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +95629,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 +95806,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78144,7 +95849,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +95871,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 +96028,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +96060,6 @@ }, { "$ref": "#/components/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 +96086,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78325,7 +96143,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +96372,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 +96549,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78713,7 +96592,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +96614,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 +96771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +96803,6 @@ }, { "$ref": "#/components/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 +96829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78894,7 +96886,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +97115,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 +97292,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79282,7 +97335,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +97357,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 +97514,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +97546,6 @@ }, { "$ref": "#/components/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 +97572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79463,7 +97629,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +98479,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 +98788,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80604,7 +98831,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +98853,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 +99010,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +99042,6 @@ }, { "$ref": "#/components/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 +99068,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80785,7 +99125,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +99449,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 +99626,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81268,7 +99669,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +99695,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 +99860,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +99892,6 @@ }, { "$ref": "#/components/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 +99918,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81453,7 +99975,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +100223,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 +100400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81860,7 +100443,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +100480,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 +100667,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +100699,6 @@ }, { "$ref": "#/components/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 +100725,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82056,7 +100782,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +101056,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 +101218,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82479,7 +101261,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +101282,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 +101437,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +101469,6 @@ }, { "$ref": "#/components/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 +101495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82659,7 +101552,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +101772,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 +101949,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83038,7 +101992,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +102013,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 +102168,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +102200,6 @@ }, { "$ref": "#/components/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 +102226,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83218,7 +102283,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +102510,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 +102687,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83604,7 +102730,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +102751,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 +102906,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +102938,6 @@ }, { "$ref": "#/components/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 +102964,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83784,7 +103021,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +103251,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 +103428,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84173,7 +103471,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +103495,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 +103656,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +103688,6 @@ }, { "$ref": "#/components/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 +103714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84356,7 +103771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +104001,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 +104178,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84745,7 +104221,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104242,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 +104397,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +104429,6 @@ }, { "$ref": "#/components/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 +104455,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84925,7 +104512,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +104740,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 +104917,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85312,7 +104960,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104982,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 +105139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +105171,6 @@ }, { "$ref": "#/components/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 +105197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85493,7 +105254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +105583,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 +105758,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85967,7 +105801,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +105822,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 +105977,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +106009,6 @@ }, { "$ref": "#/components/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 +106035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86147,7 +106092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +106308,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 +106485,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86522,7 +106528,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +106550,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 +106707,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +106739,6 @@ }, { "$ref": "#/components/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 +106765,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86703,7 +106822,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +107054,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 +107231,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87094,7 +107274,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +107299,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 +107462,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +107494,6 @@ }, { "$ref": "#/components/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 +107520,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87278,7 +107577,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +107812,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 +107989,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87672,7 +108032,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +108057,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 +108220,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +108252,6 @@ }, { "$ref": "#/components/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 +108278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87856,7 +108335,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +108571,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 +108748,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88251,7 +108791,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +108817,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 +108982,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +109014,6 @@ }, { "$ref": "#/components/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 +109040,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88436,7 +109097,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +109334,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 +109511,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88832,7 +109554,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +109580,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 +109745,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +109777,6 @@ }, { "$ref": "#/components/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 +109803,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89017,7 +109860,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +110097,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 +110274,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89413,7 +110317,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +110343,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 +110508,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +110540,6 @@ }, { "$ref": "#/components/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 +110566,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89598,7 +110623,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +110855,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 +111032,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89989,7 +111075,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +111096,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 +111251,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +111283,6 @@ }, { "$ref": "#/components/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 +111309,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90169,7 +111366,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +112013,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 +112232,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91012,7 +112275,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +112296,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 +112451,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +112483,6 @@ }, { "$ref": "#/components/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 +112509,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91192,7 +112566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +112827,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 +113004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91612,7 +113047,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +113068,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 +113223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +113255,6 @@ }, { "$ref": "#/components/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 +113281,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91792,7 +113338,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +113565,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 +113742,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92178,7 +113785,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +113806,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 +113961,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +113993,6 @@ }, { "$ref": "#/components/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 +114019,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92358,7 +114076,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +114687,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 +114919,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93183,7 +114962,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +114983,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 +115138,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +115170,6 @@ }, { "$ref": "#/components/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 +115196,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93363,7 +115253,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +115519,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 +115696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93788,7 +115739,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +115761,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 +115918,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +115950,6 @@ }, { "$ref": "#/components/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 +115976,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93969,7 +116033,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +116269,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 +116446,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94364,7 +116489,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +116518,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 +116689,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +116721,6 @@ }, { "$ref": "#/components/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 +116747,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94552,7 +116804,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +117047,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 +117224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94954,7 +117267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +117296,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 +117467,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +117499,6 @@ }, { "$ref": "#/components/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 +117525,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95142,7 +117582,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +117817,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 +117994,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95536,7 +118037,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +118058,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 +118213,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +118245,6 @@ }, { "$ref": "#/components/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 +118271,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95716,7 +118328,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +119193,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 +119466,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96841,7 +119509,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +119530,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 +119685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +119717,6 @@ }, { "$ref": "#/components/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 +119743,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97021,7 +119800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +120098,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 +120275,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97478,7 +120318,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +120339,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 +120494,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +120526,6 @@ }, { "$ref": "#/components/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 +120552,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97658,7 +120609,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +120854,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 +121031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98062,7 +121074,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +121113,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 +121304,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +121336,6 @@ }, { "$ref": "#/components/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 +121362,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98260,7 +121419,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +121701,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": [ + "educationOrganizationIdentificationSystemDescriptor", + "educationOrganizationId" + ], + "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 +121860,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98683,7 +121903,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +121924,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 +122079,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +122111,6 @@ }, { "$ref": "#/components/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 +122137,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98863,7 +122194,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +122430,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 +122607,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99258,7 +122650,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +122689,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 +122880,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +122912,6 @@ }, { "$ref": "#/components/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 +122938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99456,7 +122995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +123310,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 +123484,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99922,7 +123527,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +123548,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 +123703,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +123735,6 @@ }, { "$ref": "#/components/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 +123761,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100102,7 +123818,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +124097,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 +124256,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100522,7 +124299,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +124320,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 +124475,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +124507,6 @@ }, { "$ref": "#/components/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 +124533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100702,7 +124590,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +125535,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 +125969,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102068,7 +126012,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +126033,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 +126188,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +126220,6 @@ }, { "$ref": "#/components/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 +126246,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102248,7 +126303,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +126555,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 +126696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102623,7 +126739,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +126760,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 +126915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +126947,6 @@ }, { "$ref": "#/components/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 +126973,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102803,7 +127030,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +127245,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 +127422,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103177,7 +127465,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +127490,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 +127653,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +127685,6 @@ }, { "$ref": "#/components/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 +127711,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103361,7 +127768,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +128996,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 +129169,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104749,7 +129212,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +129234,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 +129391,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +129423,6 @@ }, { "$ref": "#/components/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 +129449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104930,7 +129506,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +129760,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 +129937,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105343,7 +129980,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +130014,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 +130195,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +130227,6 @@ }, { "$ref": "#/components/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 +130253,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105536,7 +130310,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +130675,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 +130851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106053,7 +130894,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +130915,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 +131070,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +131102,6 @@ }, { "$ref": "#/components/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 +131128,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106233,7 +131185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +131410,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 +131587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106617,7 +131630,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +131652,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 +131809,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +131841,6 @@ }, { "$ref": "#/components/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 +131867,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106798,7 +131924,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +132166,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 +132343,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107199,7 +132386,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +132421,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 +132604,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +132636,6 @@ }, { "$ref": "#/components/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 +132662,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107393,7 +132719,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +132960,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 +133137,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107793,7 +133180,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +133201,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 +133356,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +133388,6 @@ }, { "$ref": "#/components/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 +133414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107973,7 +133471,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +133698,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 +133875,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108359,7 +133918,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +133939,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 +134094,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +134126,6 @@ }, { "$ref": "#/components/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 +134152,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108539,7 +134209,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +134436,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 +134613,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108925,7 +134656,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +134677,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 +134832,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +134864,6 @@ }, { "$ref": "#/components/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 +134890,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109105,7 +134947,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +135174,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 +135351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109491,7 +135394,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +135415,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 +135570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +135602,6 @@ }, { "$ref": "#/components/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 +135628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109671,7 +135685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +135916,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 +136093,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110061,7 +136136,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +136161,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 +136324,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +136356,6 @@ }, { "$ref": "#/components/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 +136382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110245,7 +136439,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +136674,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 +136851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110639,7 +136894,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +136919,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 +137082,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +137114,6 @@ }, { "$ref": "#/components/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 +137140,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110823,7 +137197,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +137432,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 +137609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111217,7 +137652,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +137677,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 +137840,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +137872,6 @@ }, { "$ref": "#/components/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 +137898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111401,7 +137955,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +138186,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 +138363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111791,7 +138406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +138427,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 +138582,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +138614,6 @@ }, { "$ref": "#/components/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 +138640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111971,7 +138697,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +138924,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 +139101,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112357,7 +139144,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +139165,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 +139320,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +139352,6 @@ }, { "$ref": "#/components/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 +139378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112537,7 +139435,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +139662,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 +139839,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112923,7 +139882,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +139903,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 +140058,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +140090,6 @@ }, { "$ref": "#/components/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 +140116,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113103,7 +140173,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +140400,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 +140577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113489,7 +140620,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +140641,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 +140796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +140828,6 @@ }, { "$ref": "#/components/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 +140854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113669,7 +140911,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +141732,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": [ + "evaluationElementTitle", + "educationOrganizationId", + "evaluationDate", + "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 +142080,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114766,7 +142123,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +142144,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 +142299,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +142331,6 @@ }, { "$ref": "#/components/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 +142357,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114946,7 +142414,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +143053,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": [ + "evaluationElementTitle", + "educationOrganizationId", + "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 +143343,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115818,7 +143386,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +143407,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 +143562,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +143594,6 @@ }, { "$ref": "#/components/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 +143620,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115998,7 +143677,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +144445,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": [ + "evaluationObjectiveTitle", + "evaluationTitle", + "educationOrganizationId", + "evaluationDate", + "evaluationPeriodDescriptor", + "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 +144746,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117001,7 +144789,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +144810,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 +144965,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +144997,6 @@ }, { "$ref": "#/components/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 +145023,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117181,7 +145080,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +145691,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": [ + "evaluationObjectiveTitle", + "educationOrganizationId", + "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 +145973,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118023,7 +146016,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +146037,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 +146192,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +146224,6 @@ }, { "$ref": "#/components/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 +146250,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118203,7 +146307,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +146586,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 +146763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118641,7 +146806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +146827,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 +146982,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +147014,6 @@ }, { "$ref": "#/components/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 +147040,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118821,7 +147097,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +147324,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 +147501,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119207,7 +147544,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +147565,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 +147720,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +147752,6 @@ }, { "$ref": "#/components/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 +147778,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119387,7 +147835,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +148064,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 +148241,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119775,7 +148284,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +148307,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 +148466,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +148498,6 @@ }, { "$ref": "#/components/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 +148524,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119957,7 +148581,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +149541,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": [ + "evaluationDate", + "evaluationTitle", + "performanceEvaluationTypeDescriptor", + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "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 +149883,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121199,7 +149926,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +149947,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 +150102,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +150134,6 @@ }, { "$ref": "#/components/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 +150160,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121379,7 +150217,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +150706,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 +150964,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122078,7 +151007,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +151029,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 +151186,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +151218,6 @@ }, { "$ref": "#/components/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 +151244,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122259,7 +151301,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +151562,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 +151739,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122679,7 +151782,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +151803,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 +151958,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +151990,6 @@ }, { "$ref": "#/components/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 +152016,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122859,7 +152073,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +152607,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": [ + "evaluationTitle", + "educationOrganizationId", + "evaluationPeriodDescriptor", + "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 +152872,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123613,7 +152915,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +152936,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 +153091,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +153123,6 @@ }, { "$ref": "#/components/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 +153149,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123793,7 +153206,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +153480,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 +153657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124226,7 +153700,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +153722,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 +153879,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +153911,6 @@ }, { "$ref": "#/components/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 +153937,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124407,7 +153994,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +154226,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 +154403,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124798,7 +154446,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +154471,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 +154634,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +154666,6 @@ }, { "$ref": "#/components/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 +154692,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124982,7 +154749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +154993,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 +155170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125385,7 +155213,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +155247,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 +155428,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +155460,6 @@ }, { "$ref": "#/components/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 +155486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125578,7 +155543,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +155861,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 +156035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126047,7 +156078,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +156099,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 +156254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +156286,6 @@ }, { "$ref": "#/components/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 +156312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126227,7 +156369,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +156735,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", + "studentUniqueId", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "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 +156968,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126777,7 +157011,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +157032,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 +157187,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +157219,6 @@ }, { "$ref": "#/components/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 +157245,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126957,7 +157302,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +157788,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 +158014,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127645,7 +158057,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +158078,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 +158233,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +158265,6 @@ }, { "$ref": "#/components/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 +158291,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127825,7 +158348,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +158599,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 +158776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128235,7 +158819,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +158840,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 +158995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +159027,6 @@ }, { "$ref": "#/components/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 +159053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128415,7 +159110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +159442,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 +159633,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128915,7 +159676,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +159697,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 +159852,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +159884,6 @@ }, { "$ref": "#/components/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 +159910,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129095,7 +159967,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160200,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 +160377,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129487,7 +160420,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +160441,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 +160596,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160628,6 @@ }, { "$ref": "#/components/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 +160654,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129667,7 +160711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160999,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 +161149,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130087,7 +161192,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +161213,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 +161368,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +161400,6 @@ }, { "$ref": "#/components/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 +161426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130267,7 +161483,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +161752,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 +161902,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130668,7 +161945,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +161966,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 +162121,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +162153,6 @@ }, { "$ref": "#/components/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 +162179,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130848,7 +162236,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +162444,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 +162621,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131215,7 +162664,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +162685,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 +162840,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +162872,6 @@ }, { "$ref": "#/components/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 +162898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131395,7 +162955,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +163182,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 +163359,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131781,7 +163402,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +163423,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 +163578,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +163610,6 @@ }, { "$ref": "#/components/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 +163636,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131961,7 +163693,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +164435,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 +164797,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133036,7 +164840,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +164861,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 +165016,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +165048,6 @@ }, { "$ref": "#/components/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 +165074,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133216,7 +165131,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +165492,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 +165669,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133736,7 +165712,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +165761,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 +165972,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +166004,6 @@ }, { "$ref": "#/components/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 +166030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133944,7 +166087,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +166348,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 +166525,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134364,7 +166568,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +166595,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 +166762,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +166794,6 @@ }, { "$ref": "#/components/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 +166820,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134550,7 +166877,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +167111,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 +167288,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134943,7 +167331,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +167353,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 +167510,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +167542,6 @@ }, { "$ref": "#/components/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 +167568,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135124,7 +167625,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +168222,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 +168506,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135986,7 +168549,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +168571,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 +168728,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +168760,6 @@ }, { "$ref": "#/components/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 +168786,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136167,7 +168843,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +169139,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 +169316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136622,7 +169359,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +169381,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 +169538,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +169570,6 @@ }, { "$ref": "#/components/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 +169596,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136803,7 +169653,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +170393,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": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "beginDate", + "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 +170731,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137818,7 +170774,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +170796,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 +170953,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +170985,6 @@ }, { "$ref": "#/components/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 +171011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137999,7 +171068,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +171380,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 +171557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138470,7 +171600,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +171623,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 +171782,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +171814,6 @@ }, { "$ref": "#/components/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 +171840,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138652,7 +171897,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +172284,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 +172491,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139218,7 +172534,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +172557,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 +172716,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +172748,6 @@ }, { "$ref": "#/components/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 +172774,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139400,7 +172831,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +173076,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 +173253,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139804,7 +173296,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +173318,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 +173475,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +173507,6 @@ }, { "$ref": "#/components/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 +173533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139985,7 +173590,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +174871,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 +175062,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141434,7 +175105,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +175127,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 +175284,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +175316,6 @@ }, { "$ref": "#/components/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 +175342,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141615,7 +175399,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +175651,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 +175828,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142026,7 +175871,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +175894,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 +176053,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +176085,6 @@ }, { "$ref": "#/components/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 +176111,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142208,7 +176168,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +176397,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 +176574,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142596,7 +176617,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +176638,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 +176793,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +176825,6 @@ }, { "$ref": "#/components/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 +176851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142776,7 +176908,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +177135,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 +177312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143162,7 +177355,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +177376,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 +177531,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +177563,6 @@ }, { "$ref": "#/components/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 +177589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143342,7 +177646,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +177873,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 +178050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143728,7 +178093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +178114,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 +178269,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +178301,6 @@ }, { "$ref": "#/components/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 +178327,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143908,7 +178384,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +178611,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 +178788,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144294,7 +178831,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +178852,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 +179007,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +179039,6 @@ }, { "$ref": "#/components/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 +179065,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144474,7 +179122,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +179349,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 +179526,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144860,7 +179569,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +179590,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 +179745,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +179777,6 @@ }, { "$ref": "#/components/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 +179803,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145040,7 +179860,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +180086,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 +180263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145425,7 +180306,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +180326,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 +180479,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +180511,6 @@ }, { "$ref": "#/components/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 +180537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145604,7 +180594,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +180820,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 +180997,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145989,7 +181040,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +181061,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 +181216,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +181248,6 @@ }, { "$ref": "#/components/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 +181274,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146169,7 +181331,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +181558,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 +181735,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146555,7 +181778,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +181799,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 +181954,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +181986,6 @@ }, { "$ref": "#/components/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 +182012,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146735,7 +182069,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +182314,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 +182491,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147139,7 +182534,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +182573,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 +182764,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +182796,6 @@ }, { "$ref": "#/components/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 +182822,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147337,7 +182879,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +183142,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 +183319,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147759,7 +183362,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +183401,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 +183592,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +183624,6 @@ }, { "$ref": "#/components/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 +183650,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147957,7 +183707,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +183970,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 +184147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148379,7 +184190,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +184229,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 +184420,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +184452,6 @@ }, { "$ref": "#/components/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 +184478,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148577,7 +184535,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +184798,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 +184975,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148999,7 +185018,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +185057,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 +185248,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +185280,6 @@ }, { "$ref": "#/components/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 +185306,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149197,7 +185363,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +185608,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 +185785,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149601,7 +185828,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +185849,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 +186004,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +186036,6 @@ }, { "$ref": "#/components/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 +186062,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149781,7 +186119,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +186345,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 +186522,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150166,7 +186565,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +186585,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 +186738,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +186770,6 @@ }, { "$ref": "#/components/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 +186796,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150345,7 +186853,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +187092,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 +187269,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150743,7 +187312,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +187346,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 +187527,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +187559,6 @@ }, { "$ref": "#/components/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 +187585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150936,7 +187642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +187883,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 +188060,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151336,7 +188103,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +188125,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 +188282,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +188314,6 @@ }, { "$ref": "#/components/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 +188340,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151517,7 +188397,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +188626,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 +188803,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151905,7 +188846,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +188868,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 +189025,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +189057,6 @@ }, { "$ref": "#/components/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 +189083,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152086,7 +189140,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +189369,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 +189546,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152474,7 +189589,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +189611,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 +189768,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +189800,6 @@ }, { "$ref": "#/components/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 +189826,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152655,7 +189883,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +190112,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 +190289,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153043,7 +190332,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +190354,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 +190511,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +190543,6 @@ }, { "$ref": "#/components/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 +190569,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153224,7 +190626,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +191340,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 +191527,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154107,7 +191570,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +191591,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 +191746,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +191778,6 @@ }, { "$ref": "#/components/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 +191804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154287,7 +191861,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +192731,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 +192919,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155327,7 +192962,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +192983,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 +193138,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +193170,6 @@ }, { "$ref": "#/components/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 +193196,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155507,7 +193253,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +194230,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 +194435,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156671,7 +194478,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +194500,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 +194657,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +194689,6 @@ }, { "$ref": "#/components/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 +194715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156852,7 +194772,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +195047,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 +195224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157286,7 +195267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +195309,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 +195506,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +195538,6 @@ }, { "$ref": "#/components/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 +195564,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157487,7 +195621,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +195869,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 +196046,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157894,7 +196089,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +196110,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 +196265,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +196297,6 @@ }, { "$ref": "#/components/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 +196323,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158074,7 +196380,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +196621,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 +196798,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158474,7 +196841,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +196876,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 +197059,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +197091,6 @@ }, { "$ref": "#/components/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 +197117,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158668,7 +197174,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +197421,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 +197598,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159074,7 +197641,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +197668,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 +197835,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +197867,6 @@ }, { "$ref": "#/components/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 +197893,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159260,7 +197950,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +198285,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 +198470,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159756,7 +198513,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +198534,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 +198689,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +198721,6 @@ }, { "$ref": "#/components/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 +198747,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159936,7 +198804,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +199037,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 +199214,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160328,7 +199257,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +199278,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 +199433,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +199465,6 @@ }, { "$ref": "#/components/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 +199491,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160508,7 +199548,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +199781,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 +199958,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160900,7 +200001,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +200028,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 +200195,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +200227,6 @@ }, { "$ref": "#/components/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 +200253,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161086,7 +200310,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +201139,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 +201349,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162112,7 +201392,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +201419,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 +201586,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +201618,6 @@ }, { "$ref": "#/components/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 +201644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162298,7 +201701,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +201965,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 +202142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162721,7 +202185,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +202206,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 +202361,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +202393,6 @@ }, { "$ref": "#/components/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 +202419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162901,7 +202476,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +202715,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 +202892,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163299,7 +202935,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +202968,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 +203147,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +203179,6 @@ }, { "$ref": "#/components/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 +203205,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163491,7 +203262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +203501,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 +203678,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163889,7 +203721,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +203742,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 +203897,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +203929,6 @@ }, { "$ref": "#/components/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 +203955,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164069,7 +204012,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +204239,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 +204416,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164455,7 +204459,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +204480,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 +204635,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +204667,6 @@ }, { "$ref": "#/components/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 +204693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164635,7 +204750,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +204979,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 +205156,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165023,7 +205199,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +205222,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 +205381,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +205413,6 @@ }, { "$ref": "#/components/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 +205439,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165205,7 +205496,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +205913,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 +206098,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165784,7 +206141,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +206162,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 +206317,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +206349,6 @@ }, { "$ref": "#/components/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 +206375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165964,7 +206432,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +206753,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": [ + "asOfDate", + "accountIdentifier", + "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 +206942,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166446,7 +206985,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +207006,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 +207161,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +207193,6 @@ }, { "$ref": "#/components/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 +207219,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166626,7 +207276,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +207592,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": [ + "asOfDate", + "accountIdentifier", + "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 +207781,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167103,7 +207824,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +207845,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 +208000,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +208032,6 @@ }, { "$ref": "#/components/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 +208058,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167283,7 +208115,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +208475,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": [ + "asOfDate", + "accountIdentifier", + "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 +208679,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167814,7 +208722,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +208743,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 +208898,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +208930,6 @@ }, { "$ref": "#/components/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 +208956,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167994,7 +209013,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +210728,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 +210948,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169916,7 +210991,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +211014,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 +211173,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +211205,6 @@ }, { "$ref": "#/components/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 +211231,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170098,7 +211288,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +211565,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 +211742,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170534,7 +211785,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +211808,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 +211967,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +211999,6 @@ }, { "$ref": "#/components/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 +212025,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170716,7 +212082,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +212397,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": [ + "asOfDate", + "accountIdentifier", + "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 +212586,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171192,7 +212629,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +212650,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 +212805,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +212837,6 @@ }, { "$ref": "#/components/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 +212863,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171372,7 +212920,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +213280,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": [ + "asOfDate", + "accountIdentifier", + "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 +213484,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171903,7 +213527,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +213548,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 +213703,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +213735,6 @@ }, { "$ref": "#/components/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 +213761,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172083,7 +213818,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +214078,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 +214255,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172502,7 +214298,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +214342,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 +214543,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +214575,6 @@ }, { "$ref": "#/components/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 +214601,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172705,7 +214658,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +214944,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 +215103,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173132,7 +215146,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +215168,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 +215325,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +215357,6 @@ }, { "$ref": "#/components/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 +215383,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173313,7 +215440,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +215673,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 +215850,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173705,7 +215893,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +215927,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 +216108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +216140,6 @@ }, { "$ref": "#/components/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 +216166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173898,7 +216223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +216477,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 +216654,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174311,7 +216697,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +216732,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 +216915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +216947,6 @@ }, { "$ref": "#/components/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 +216973,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174505,7 +217030,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +217274,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 +217451,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174908,7 +217494,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +217518,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 +217679,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +217711,6 @@ }, { "$ref": "#/components/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 +217737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175091,7 +217794,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +218024,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 +218201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175480,7 +218244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +218265,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 +218420,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +218452,6 @@ }, { "$ref": "#/components/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 +218478,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175660,7 +218535,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +218762,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 +218939,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176046,7 +218982,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +219003,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 +219158,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +219190,6 @@ }, { "$ref": "#/components/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 +219216,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176226,7 +219273,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +219500,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 +219677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176612,7 +219720,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +219741,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 +219896,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +219928,6 @@ }, { "$ref": "#/components/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 +219954,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176792,7 +220011,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +220238,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 +220415,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177178,7 +220458,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +220479,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 +220634,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +220666,6 @@ }, { "$ref": "#/components/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 +220692,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177358,7 +220749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +220976,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 +221153,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177744,7 +221196,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +221217,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 +221372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +221404,6 @@ }, { "$ref": "#/components/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 +221430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177924,7 +221487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +221714,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 +221891,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178310,7 +221934,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +221955,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 +222110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +222142,6 @@ }, { "$ref": "#/components/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 +222168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178490,7 +222225,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +222452,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 +222629,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178876,7 +222672,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +222693,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 +222848,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +222880,6 @@ }, { "$ref": "#/components/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 +222906,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179056,7 +222963,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +223251,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 +223401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179476,7 +223444,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +223465,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 +223620,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +223652,6 @@ }, { "$ref": "#/components/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 +223678,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179656,7 +223735,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +224586,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", + "namespace", + "identificationCode" + ], + "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 +224789,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180686,7 +224832,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +224854,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 +225011,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +225043,6 @@ }, { "$ref": "#/components/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 +225069,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180867,7 +225126,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +225376,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 +225553,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181276,7 +225596,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +225617,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 +225772,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +225804,6 @@ }, { "$ref": "#/components/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 +225830,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181456,7 +225887,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +226114,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 +226291,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181842,7 +226334,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +226355,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 +226510,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +226542,6 @@ }, { "$ref": "#/components/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 +226568,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182022,7 +226625,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +226852,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 +227029,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182408,7 +227072,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +227093,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 +227248,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +227280,6 @@ }, { "$ref": "#/components/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 +227306,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182588,7 +227363,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +227659,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": [ + "eventDate", + "openStaffPositionEventTypeDescriptor", + "educationOrganizationId", + "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 +227839,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183036,7 +227882,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +227903,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 +228058,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +228090,6 @@ }, { "$ref": "#/components/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 +228116,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183216,7 +228173,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +228397,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 +228574,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183599,7 +228617,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +228638,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 +228793,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +228825,6 @@ }, { "$ref": "#/components/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 +228851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183779,7 +228908,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +229629,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 +229931,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184784,7 +229974,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +229995,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 +230150,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +230182,6 @@ }, { "$ref": "#/components/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 +230208,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184964,7 +230265,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +230597,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 +230774,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185455,7 +230817,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +230856,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 +231047,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +231079,6 @@ }, { "$ref": "#/components/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 +231105,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185653,7 +231162,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +231468,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 +231618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186091,7 +231661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +231682,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 +231837,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +231869,6 @@ }, { "$ref": "#/components/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 +231895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186271,7 +231952,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +233177,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 +233359,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187665,7 +233402,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +233423,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 +233578,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +233610,6 @@ }, { "$ref": "#/components/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 +233636,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187845,7 +233693,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +233962,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 +234139,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188273,7 +234182,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +234225,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 +234424,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +234456,6 @@ }, { "$ref": "#/components/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 +234482,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188475,7 +234539,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +234788,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 +234965,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188883,7 +235008,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +235029,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 +235184,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +235216,6 @@ }, { "$ref": "#/components/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 +235242,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189063,7 +235299,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +235526,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 +235703,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189449,7 +235746,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +235767,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 +235922,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +235954,6 @@ }, { "$ref": "#/components/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 +235980,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189629,7 +236037,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +236264,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 +236441,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190015,7 +236484,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +236505,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 +236660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +236692,6 @@ }, { "$ref": "#/components/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 +236718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190195,7 +236775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +237002,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 +237179,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190581,7 +237222,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +237243,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 +237398,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +237430,6 @@ }, { "$ref": "#/components/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 +237456,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190761,7 +237513,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +237765,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 +237927,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191156,7 +237970,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +237991,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 +238146,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +238178,6 @@ }, { "$ref": "#/components/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 +238204,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191336,7 +238261,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +238475,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 +238652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191709,7 +238695,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +238716,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 +238871,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +238903,6 @@ }, { "$ref": "#/components/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 +238929,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191889,7 +238986,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +239347,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": [ + "pathPhaseName", + "educationOrganizationId", + "pathName" + ], + "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 +239525,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -192403,7 +239568,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +239589,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 +239744,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +239776,6 @@ }, { "$ref": "#/components/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 +239802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -192583,7 +239859,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +240145,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 +240308,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193013,7 +240351,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +240372,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 +240527,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +240559,6 @@ }, { "$ref": "#/components/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 +240585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193193,7 +240642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +240845,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 +240986,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193519,7 +241029,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +241051,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 +241208,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +241240,6 @@ }, { "$ref": "#/components/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 +241266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193700,7 +241323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +241527,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 +241704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194063,7 +241747,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +241769,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 +241926,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +241958,6 @@ }, { "$ref": "#/components/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 +241984,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194244,7 +242041,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +242269,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 +242446,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194631,7 +242489,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +242510,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 +242665,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +242697,6 @@ }, { "$ref": "#/components/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 +242723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194811,7 +242780,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +243569,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", + "schoolYear", + "termDescriptor", + "personId", + "sourceSystemDescriptor" + ], + "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 +243873,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195855,7 +243916,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +243937,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 +244092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +244124,6 @@ }, { "$ref": "#/components/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 +244150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196035,7 +244207,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +244505,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 +244682,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196492,7 +244725,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +244746,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 +244901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +244933,6 @@ }, { "$ref": "#/components/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 +244959,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196672,7 +245016,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +245578,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 +245799,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197416,7 +245842,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +245863,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 +246018,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +246050,6 @@ }, { "$ref": "#/components/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 +246076,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197596,7 +246133,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +246384,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 +246561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198006,7 +246604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +246627,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 +246786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +246818,6 @@ }, { "$ref": "#/components/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 +246844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198188,7 +246901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +247129,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 +247306,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198575,7 +247349,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +247369,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 +247522,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +247554,6 @@ }, { "$ref": "#/components/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 +247580,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198754,7 +247637,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +247866,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 +248043,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199142,7 +248086,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +248110,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 +248271,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +248303,6 @@ }, { "$ref": "#/components/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 +248329,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199325,7 +248386,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +248630,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 +248807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199728,7 +248850,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +248885,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 +249068,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +249100,6 @@ }, { "$ref": "#/components/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 +249126,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199922,7 +249183,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +249424,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 +249601,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200322,7 +249644,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +249665,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 +249820,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +249852,6 @@ }, { "$ref": "#/components/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 +249878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200502,7 +249935,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +250224,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 +250390,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200934,7 +250433,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +250454,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 +250609,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +250641,6 @@ }, { "$ref": "#/components/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 +250667,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201114,7 +250724,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +250940,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 +251117,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201489,7 +251160,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +251182,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 +251339,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +251371,6 @@ }, { "$ref": "#/components/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 +251397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201670,7 +251454,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +252763,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 +252953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203156,7 +252996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +253018,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 +253175,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +253207,6 @@ }, { "$ref": "#/components/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 +253233,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203337,7 +253290,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +253543,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 +253720,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203749,7 +253763,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +253784,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 +253939,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +253971,6 @@ }, { "$ref": "#/components/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 +253997,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203929,7 +254054,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +254281,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 +254458,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204315,7 +254501,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +254522,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 +254677,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +254709,6 @@ }, { "$ref": "#/components/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 +254735,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204495,7 +254792,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +255020,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 +255197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204882,7 +255240,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +255262,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 +255419,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +255451,6 @@ }, { "$ref": "#/components/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 +255477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205063,7 +255534,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +255763,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 +255940,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205451,7 +255983,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +256005,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 +256162,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +256194,6 @@ }, { "$ref": "#/components/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 +256220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205632,7 +256277,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +256506,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 +256683,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206020,7 +256726,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +256748,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 +256905,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +256937,6 @@ }, { "$ref": "#/components/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 +256963,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206201,7 +257020,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +257372,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", + "personId", + "sourceSystemDescriptor", + "namespace", + "professionalDevelopmentTitle" + ], + "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 +257580,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206726,7 +257623,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +257644,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 +257799,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +257831,6 @@ }, { "$ref": "#/components/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 +257857,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206906,7 +257914,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +258230,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 +258419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207391,7 +258462,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +258483,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 +258638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +258670,6 @@ }, { "$ref": "#/components/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 +258696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207571,7 +258753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +258985,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 +259162,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207962,7 +259205,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +259225,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 +259378,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +259410,6 @@ }, { "$ref": "#/components/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 +259436,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208141,7 +259493,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +259719,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 +259896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208526,7 +259939,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +259960,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 +260115,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +260147,6 @@ }, { "$ref": "#/components/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 +260173,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208706,7 +260230,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +260459,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 +260636,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209094,7 +260679,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +260702,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 +260861,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +260893,6 @@ }, { "$ref": "#/components/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 +260919,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209276,7 +260976,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +261216,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 +261393,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209675,7 +261436,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +261468,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 +261645,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +261677,6 @@ }, { "$ref": "#/components/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 +261703,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209866,7 +261760,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +262059,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 +262209,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210297,7 +262252,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +262273,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 +262428,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +262460,6 @@ }, { "$ref": "#/components/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 +262486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210477,7 +262543,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +263157,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": [ + "programEvaluationElementTitle", + "programEducationOrganizationId", + "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 +263419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211310,7 +263462,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +263484,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 +263641,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +263673,6 @@ }, { "$ref": "#/components/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 +263699,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211491,7 +263756,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +264309,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": [ + "programEvaluationObjectiveTitle", + "programEducationOrganizationId", + "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 +264561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212253,7 +264604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +264626,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 +264783,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +264815,6 @@ }, { "$ref": "#/components/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 +264841,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212434,7 +264898,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +265167,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 +265344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212862,7 +265387,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +265409,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 +265566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +265598,6 @@ }, { "$ref": "#/components/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 +265624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213043,7 +265681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +265910,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 +266087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213431,7 +266130,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +266152,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 +266309,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +266341,6 @@ }, { "$ref": "#/components/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 +266367,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213612,7 +266424,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +266916,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": [ + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programEducationOrganizationId", + "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 +267144,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214294,7 +267187,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +267209,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 +267366,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +267398,6 @@ }, { "$ref": "#/components/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 +267424,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214475,7 +267481,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +267747,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 +267924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214900,7 +267967,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +267999,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 +268176,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +268208,6 @@ }, { "$ref": "#/components/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 +268234,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215091,7 +268291,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +268541,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 +268718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215500,7 +268761,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +268794,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 +268973,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +269005,6 @@ }, { "$ref": "#/components/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 +269031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215692,7 +269088,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +269557,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 +269722,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216303,7 +269765,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +269797,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 +269974,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +270006,6 @@ }, { "$ref": "#/components/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 +270032,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216494,7 +270089,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +270324,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 +270501,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216888,7 +270544,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +270565,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 +270720,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +270752,6 @@ }, { "$ref": "#/components/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 +270778,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217068,7 +270835,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +271062,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 +271239,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217454,7 +271282,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +271303,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 +271458,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +271490,6 @@ }, { "$ref": "#/components/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 +271516,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217634,7 +271573,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +271861,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 +272011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218054,7 +272054,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +272075,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 +272230,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +272262,6 @@ }, { "$ref": "#/components/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 +272288,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218234,7 +272345,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +272553,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 +272730,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218601,7 +272773,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +272794,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 +272949,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +272981,6 @@ }, { "$ref": "#/components/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 +273007,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218781,7 +273064,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +273291,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 +273468,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219167,7 +273511,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +273532,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 +273687,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +273719,6 @@ }, { "$ref": "#/components/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 +273745,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219347,7 +273802,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +274029,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 +274206,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219733,7 +274249,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +274270,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 +274425,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +274457,6 @@ }, { "$ref": "#/components/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 +274483,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219913,7 +274540,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +274774,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 +274951,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220306,7 +274994,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +275022,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 +275191,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +275223,6 @@ }, { "$ref": "#/components/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 +275249,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220493,7 +275306,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +275540,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 +275717,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220886,7 +275760,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +275781,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 +275936,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +275968,6 @@ }, { "$ref": "#/components/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 +275994,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221066,7 +276051,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +276761,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", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor", + "evaluationElementTitle", + "quantitativeMeasureIdentifier" + ], + "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 +277095,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222032,7 +277138,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +277159,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 +277314,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +277346,6 @@ }, { "$ref": "#/components/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 +277372,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222212,7 +277429,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +277717,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 +277894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222659,7 +277937,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +277958,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 +278113,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +278145,6 @@ }, { "$ref": "#/components/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 +278171,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222839,7 +278228,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +278665,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", + "schoolYear", + "termDescriptor", + "quantitativeMeasureIdentifier" + ], + "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 +278954,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223502,7 +278997,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +279018,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 +279173,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +279205,6 @@ }, { "$ref": "#/components/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 +279231,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223682,7 +279288,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +279554,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 +279731,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224107,7 +279774,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +279795,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 +279950,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +279982,6 @@ }, { "$ref": "#/components/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 +280008,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224287,7 +280065,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +280306,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 +280483,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224687,7 +280526,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +280561,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 +280744,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +280776,6 @@ }, { "$ref": "#/components/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 +280802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224881,7 +280859,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +281102,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 +281279,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225283,7 +281322,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +281345,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 +281504,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +281536,6 @@ }, { "$ref": "#/components/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 +281562,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225465,7 +281619,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +281849,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 +282026,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225854,7 +282069,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +282091,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 +282248,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +282280,6 @@ }, { "$ref": "#/components/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 +282306,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226035,7 +282363,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +282592,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 +282769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226423,7 +282812,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +282834,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 +282991,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +283023,6 @@ }, { "$ref": "#/components/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 +283049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226604,7 +283106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +283347,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 +283524,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227004,7 +283567,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +283601,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 +283782,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +283814,6 @@ }, { "$ref": "#/components/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 +283840,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227197,7 +283897,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +285437,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": [ + "recruitmentEventAttendeeIdentifier", + "educationOrganizationId", + "eventDate", + "eventTitle" + ], + "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 +285800,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229071,7 +285843,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +285864,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 +286019,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +286051,6 @@ }, { "$ref": "#/components/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 +286077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229251,7 +286134,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +286486,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 +286663,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229762,7 +286706,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +286727,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 +286882,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +286914,6 @@ }, { "$ref": "#/components/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 +286940,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229942,7 +286997,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287224,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 +287401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230328,7 +287444,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +287465,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 +287620,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287652,6 @@ }, { "$ref": "#/components/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 +287678,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230508,7 +287735,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288046,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 +288229,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230979,7 +288272,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +288293,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 +288448,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288480,6 @@ }, { "$ref": "#/components/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 +288506,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231159,7 +288563,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288793,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 +288970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231548,7 +289013,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +289034,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 +289189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289221,6 @@ }, { "$ref": "#/components/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 +289247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231728,7 +289304,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289539,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 +289716,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232122,7 +289759,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +289788,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 +289959,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289991,6 @@ }, { "$ref": "#/components/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 +290017,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232310,7 +290074,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +290988,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 +291216,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233414,7 +291259,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +291281,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 +291438,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +291470,6 @@ }, { "$ref": "#/components/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 +291496,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233595,7 +291553,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +291808,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 +291985,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234009,7 +292028,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +292049,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 +292204,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +292236,6 @@ }, { "$ref": "#/components/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 +292262,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234189,7 +292319,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +292546,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 +292723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234575,7 +292766,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +292787,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 +292942,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +292974,6 @@ }, { "$ref": "#/components/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 +293000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234755,7 +293057,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293288,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 +293465,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235145,7 +293508,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +293533,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 +293696,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293728,6 @@ }, { "$ref": "#/components/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 +293754,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235329,7 +293811,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294043,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 +294220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235720,7 +294263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +294285,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 +294442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294474,6 @@ }, { "$ref": "#/components/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 +294500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235901,7 +294557,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294785,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 +294962,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236288,7 +295005,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +295026,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 +295181,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295213,6 @@ }, { "$ref": "#/components/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 +295239,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236468,7 +295296,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295523,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 +295700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236854,7 +295743,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +295764,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 +295919,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295951,6 @@ }, { "$ref": "#/components/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 +295977,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237034,7 +296034,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296534,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 +296718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237695,7 +296761,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +296782,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 +296937,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296969,6 @@ }, { "$ref": "#/components/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 +296995,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237875,7 +297052,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297292,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 +297469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238274,7 +297512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +297537,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 +297700,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297732,6 @@ }, { "$ref": "#/components/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 +297758,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238458,7 +297815,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298047,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 +298224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238849,7 +298267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +298289,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 +298446,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298478,6 @@ }, { "$ref": "#/components/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 +298504,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239030,7 +298561,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299014,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", + "schoolYear", + "termDescriptor", + "rubricRating" + ], + "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 +299310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239717,7 +299353,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +299374,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 +299529,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299561,6 @@ }, { "$ref": "#/components/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 +299587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239897,7 +299644,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299915,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 +300092,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240327,7 +300135,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +300155,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 +300308,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300340,6 @@ }, { "$ref": "#/components/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 +300366,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240506,7 +300423,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300649,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 +300826,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240891,7 +300869,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +300890,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 +301045,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301077,6 @@ }, { "$ref": "#/components/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 +301103,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241071,7 +301160,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301400,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 +301577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241470,7 +301620,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +301654,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 +301835,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301867,6 @@ }, { "$ref": "#/components/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 +301893,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241663,7 +301950,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302194,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 +302371,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242066,7 +302414,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +302439,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 +302602,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302634,6 @@ }, { "$ref": "#/components/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 +302660,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242250,7 +302717,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302950,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 +303127,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242642,7 +303170,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +303193,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 +303352,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303384,6 @@ }, { "$ref": "#/components/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 +303410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242824,7 +303467,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303696,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 +303873,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243212,7 +303916,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +303937,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 +304092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304124,6 @@ }, { "$ref": "#/components/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 +304150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243392,7 +304207,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304447,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 +304624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243791,7 +304667,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +304701,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 +304882,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304914,6 @@ }, { "$ref": "#/components/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 +304940,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243984,7 +304997,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305205,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 +305346,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244320,7 +305389,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +305409,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 +305562,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305594,6 @@ }, { "$ref": "#/components/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 +305620,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244499,7 +305677,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307280,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 +307561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246370,7 +307604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +307638,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 +307819,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307851,6 @@ }, { "$ref": "#/components/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 +307877,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246563,7 +307934,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308261,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 +308438,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247049,7 +308481,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +308502,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 +308657,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308689,6 @@ }, { "$ref": "#/components/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 +308715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247229,7 +308772,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309203,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 +309438,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247852,7 +309481,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +309502,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 +309657,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309689,6 @@ }, { "$ref": "#/components/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 +309715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248032,7 +309772,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310036,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 +310213,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248455,7 +310256,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +310289,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 +310468,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310500,6 @@ }, { "$ref": "#/components/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 +310526,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248647,7 +310583,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310834,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 +311011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249057,7 +311054,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +311087,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 +311266,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +311298,6 @@ }, { "$ref": "#/components/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 +311324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249249,7 +311381,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312340,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", + "sessionName", + "sectionIdentifier" + ], + "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 +312644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250479,7 +312687,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +312720,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 +312899,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312931,6 @@ }, { "$ref": "#/components/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 +312957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250671,7 +313014,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +313336,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 +313513,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251152,7 +313556,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +313577,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 +313732,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +313764,6 @@ }, { "$ref": "#/components/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 +313790,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251332,7 +313847,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +314074,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 +314251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251718,7 +314294,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +314315,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 +314470,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +314502,6 @@ }, { "$ref": "#/components/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 +314528,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251898,7 +314585,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +314818,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 +314995,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252290,7 +315038,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +315065,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 +315232,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +315264,6 @@ }, { "$ref": "#/components/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 +315290,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252476,7 +315347,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +315902,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 +316094,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253200,7 +316137,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +316165,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 +316334,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +316366,6 @@ }, { "$ref": "#/components/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 +316392,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253387,7 +316449,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +316716,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 +316893,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253813,7 +316936,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +316980,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 +317181,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +317213,6 @@ }, { "$ref": "#/components/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 +317239,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254016,7 +317296,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +317607,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 +317757,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254459,7 +317800,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +317821,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 +317976,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +318008,6 @@ }, { "$ref": "#/components/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 +318034,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254639,7 +318091,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +318300,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 +318477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255007,7 +318520,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +318542,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 +318699,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +318731,6 @@ }, { "$ref": "#/components/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 +318757,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255188,7 +318814,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +319043,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 +319220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255576,7 +319263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +319285,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 +319442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +319474,6 @@ }, { "$ref": "#/components/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 +319500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255757,7 +319557,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +319786,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 +319963,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256145,7 +320006,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +320028,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 +320185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +320217,6 @@ }, { "$ref": "#/components/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 +320243,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256326,7 +320300,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +320529,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 +320706,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256714,7 +320749,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +320771,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 +320928,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +320960,6 @@ }, { "$ref": "#/components/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 +320986,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256895,7 +321043,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +321340,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 +321514,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257343,7 +321557,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +321578,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 +321733,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +321765,6 @@ }, { "$ref": "#/components/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 +321791,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257523,7 +321848,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +322069,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 +322246,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257903,7 +322289,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +322310,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 +322465,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +322497,6 @@ }, { "$ref": "#/components/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 +322523,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258083,7 +322580,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +322904,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 +323092,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258567,7 +323135,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +323156,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 +323311,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +323343,6 @@ }, { "$ref": "#/components/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 +323369,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258747,7 +323426,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +324228,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 +324416,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259719,7 +324459,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +324480,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 +324635,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +324667,6 @@ }, { "$ref": "#/components/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 +324693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259899,7 +324750,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +325845,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 +325986,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261117,7 +326029,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +326050,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 +326205,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +326237,6 @@ }, { "$ref": "#/components/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 +326263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261297,7 +326320,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +326616,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 +326772,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261726,7 +326815,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +326836,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 +326991,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +327023,6 @@ }, { "$ref": "#/components/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 +327049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261906,7 +327106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +327612,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 +327878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262650,7 +327921,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +327942,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 +328097,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +328129,6 @@ }, { "$ref": "#/components/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 +328155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262830,7 +328212,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +329184,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 +329481,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264071,7 +329524,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +329545,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 +329700,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +329732,6 @@ }, { "$ref": "#/components/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 +329758,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264251,7 +329815,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +330227,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 +330426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264833,7 +330469,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +330490,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 +330645,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +330677,6 @@ }, { "$ref": "#/components/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 +330703,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265013,7 +330760,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +331078,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 +331252,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265482,7 +331295,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +331316,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 +331471,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +331503,6 @@ }, { "$ref": "#/components/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 +331529,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265662,7 +331586,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +331821,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 +331998,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266056,7 +332041,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +332072,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 +332247,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +332279,6 @@ }, { "$ref": "#/components/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 +332305,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266246,7 +332362,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +332599,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 +332776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266642,7 +332819,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +332840,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 +332995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +333027,6 @@ }, { "$ref": "#/components/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 +333053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266822,7 +333110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +333419,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 +333601,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -267290,7 +333644,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +333665,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 +333820,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +333852,6 @@ }, { "$ref": "#/components/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 +333878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -267470,7 +333935,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +334281,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 +334484,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -267986,7 +334527,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +334551,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 +334712,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +334744,6 @@ }, { "$ref": "#/components/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 +334770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -268169,7 +334827,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +335325,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 +335500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -268819,7 +335543,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +335566,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 +335725,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +335757,6 @@ }, { "$ref": "#/components/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 +335783,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269001,7 +335840,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +336292,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 +336551,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269669,7 +336594,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +336618,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 +336779,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +336811,6 @@ }, { "$ref": "#/components/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 +336837,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269852,7 +336894,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +337164,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 +337341,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -270281,7 +337384,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +337405,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 +337560,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +337592,6 @@ }, { "$ref": "#/components/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 +337618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -270461,7 +337675,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +339121,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 +339412,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272185,7 +339455,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +339486,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 +339661,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +339693,6 @@ }, { "$ref": "#/components/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 +339719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272375,7 +339776,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +340126,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 +340303,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272884,7 +340346,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +340394,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 +340603,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +340635,6 @@ }, { "$ref": "#/components/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 +340661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -273091,7 +340718,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +342118,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 +342290,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274650,7 +342333,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +342355,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 +342512,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +342544,6 @@ }, { "$ref": "#/components/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 +342570,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274831,7 +342627,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +344483,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 +344771,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -276947,7 +344814,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +344839,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 +345002,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +345034,6 @@ }, { "$ref": "#/components/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 +345060,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277131,7 +345117,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +345557,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": [ + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "assessmentIdentifier", + "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 +345769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277744,7 +345812,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +345832,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 +345985,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +346017,6 @@ }, { "$ref": "#/components/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 +346043,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277923,7 +346100,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +346541,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": [ + "assessmentBatteryPartName", + "administrationIdentifier", + "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 +346759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278538,7 +346802,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +346823,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 +346978,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +347010,6 @@ }, { "$ref": "#/components/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 +347036,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278718,7 +347093,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +347773,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", + "namespace", + "educationOrganizationId", + "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 +348054,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -279640,7 +348097,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +348118,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 +348273,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +348305,6 @@ }, { "$ref": "#/components/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 +348331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -279820,7 +348388,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +350056,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 +350374,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -281777,7 +350417,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +350439,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 +350596,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +350628,6 @@ }, { "$ref": "#/components/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 +350654,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -281958,7 +350711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +351514,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 +351766,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -282975,7 +351809,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +351830,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 +351985,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +352017,6 @@ }, { "$ref": "#/components/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 +352043,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283155,7 +352100,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +352377,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 +352554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283591,7 +352597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +352620,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 +352779,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +352811,6 @@ }, { "$ref": "#/components/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 +352837,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283773,7 +352894,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +353316,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 +353496,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -284347,7 +353539,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +353561,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 +353718,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +353750,6 @@ }, { "$ref": "#/components/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 +353776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -284528,7 +353833,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +354506,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", + "objectiveEducationOrganizationId", + "objective", + "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 +354755,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -285402,7 +354798,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +354820,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 +354977,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +355009,6 @@ }, { "$ref": "#/components/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 +355035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -285583,7 +355092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +355489,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 +355689,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286162,7 +355732,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +355753,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 +355908,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +355940,6 @@ }, { "$ref": "#/components/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 +355966,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286342,7 +356023,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +357222,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 +357437,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -287738,7 +357480,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +357501,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 +357656,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +357688,6 @@ }, { "$ref": "#/components/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 +357714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -287918,7 +357771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +358884,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 +359025,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -289154,7 +359068,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +359089,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 +359244,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +359276,6 @@ }, { "$ref": "#/components/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 +359302,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -289334,7 +359359,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +359745,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 +359937,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -289884,7 +359980,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +360001,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 +360156,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +360188,6 @@ }, { "$ref": "#/components/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 +360214,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290064,7 +360271,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +360583,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 +360739,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290509,7 +360782,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +360803,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 +360958,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +360990,6 @@ }, { "$ref": "#/components/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 +361016,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290689,7 +361073,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +361353,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 +361494,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -291092,7 +361537,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +361558,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 +361713,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +361745,6 @@ }, { "$ref": "#/components/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 +361771,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -291272,7 +361828,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +362669,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 +362890,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292316,7 +362933,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +362955,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 +363112,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +363144,6 @@ }, { "$ref": "#/components/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 +363170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292497,7 +363227,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +363581,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 +363761,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -293003,7 +363804,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +363825,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 +363980,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +364012,6 @@ }, { "$ref": "#/components/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 +364038,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -293183,7 +364095,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +364573,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 +364828,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -293892,7 +364871,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +364893,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 +365050,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +365082,6 @@ }, { "$ref": "#/components/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 +365108,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294073,7 +365165,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +365758,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 +365926,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294816,7 +365969,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +365990,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 +366145,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +366177,6 @@ }, { "$ref": "#/components/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 +366203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294996,7 +366260,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +366950,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 +367202,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -295900,7 +367245,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +367266,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 +367421,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +367453,6 @@ }, { "$ref": "#/components/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 +367479,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296080,7 +367536,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +367892,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 +368066,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296587,7 +368109,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +368130,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 +368285,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +368317,6 @@ }, { "$ref": "#/components/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 +368343,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296767,7 +368400,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +368627,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 +368804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297153,7 +368847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +368870,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 +369029,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +369061,6 @@ }, { "$ref": "#/components/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 +369087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297335,7 +369144,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +369631,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 +369825,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297993,7 +369868,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +369890,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 +370047,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +370079,6 @@ }, { "$ref": "#/components/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 +370105,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298174,7 +370162,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +370582,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", + "eventDate", + "educationOrganizationId", + "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 +370804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298783,7 +370847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +370868,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 +371023,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +371055,6 @@ }, { "$ref": "#/components/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 +371081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298963,7 +371138,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +371980,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 +372224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -300011,7 +372267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +372288,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 +372443,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +372475,6 @@ }, { "$ref": "#/components/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 +372501,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -300191,7 +372558,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +373404,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 +373711,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -301306,7 +373754,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +373775,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 +373930,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +373962,6 @@ }, { "$ref": "#/components/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 +373988,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -301486,7 +374045,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +374823,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 +375077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -302480,7 +375120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +375141,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 +375296,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +375328,6 @@ }, { "$ref": "#/components/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 +375354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -302660,7 +375411,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +375925,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": [ + "pathMilestoneName", + "pathMilestoneTypeDescriptor", + "educationOrganizationId", + "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 +376134,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -303348,7 +376177,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +376198,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 +376353,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +376385,6 @@ }, { "$ref": "#/components/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 +376411,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -303528,7 +376468,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +376961,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": [ + "pathName", + "pathPhaseName", + "educationOrganizationId", + "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 +377144,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304174,7 +377187,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +377208,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 +377363,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +377395,6 @@ }, { "$ref": "#/components/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 +377421,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304354,7 +377478,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +377813,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 +377971,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304823,7 +378014,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +378035,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 +378190,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +378222,6 @@ }, { "$ref": "#/components/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 +378248,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -305003,7 +378305,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +378928,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 +379155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -305815,7 +379198,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +379225,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 +379392,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +379424,6 @@ }, { "$ref": "#/components/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 +379450,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306001,7 +379507,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +380012,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 +380264,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306715,7 +380307,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +380330,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 +380489,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +380521,6 @@ }, { "$ref": "#/components/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 +380547,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306897,7 +380604,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +381636,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 +381923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -308168,7 +381966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +381988,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 +382145,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +382177,6 @@ }, { "$ref": "#/components/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 +382203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -308349,7 +382260,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +383273,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 +383635,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -309701,7 +383678,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +383703,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 +383866,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +383898,6 @@ }, { "$ref": "#/components/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 +383924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -309885,7 +383981,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +384623,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 +384876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310742,7 +384919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +384942,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 +385101,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +385133,6 @@ }, { "$ref": "#/components/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 +385159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310924,7 +385216,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +385910,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 +386145,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311815,7 +386188,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +386209,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 +386364,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +386396,6 @@ }, { "$ref": "#/components/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 +386422,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311995,7 +386479,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +387130,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 +387400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -312878,7 +387443,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +387464,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 +387619,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +387651,6 @@ }, { "$ref": "#/components/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 +387677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -313058,7 +387734,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +388441,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 +388744,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -314025,7 +388787,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +388816,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 +388987,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +389019,6 @@ }, { "$ref": "#/components/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 +389045,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -314213,7 +389102,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +389770,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 +390053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -315116,7 +390096,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +390119,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 +390278,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +390310,6 @@ }, { "$ref": "#/components/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 +390336,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -315298,7 +390393,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +391737,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 +392113,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -316980,7 +392156,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +392178,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 +392335,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +392367,6 @@ }, { "$ref": "#/components/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 +392393,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317161,7 +392450,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +393224,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 +393558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -318231,7 +393601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +393622,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 +393777,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +393809,6 @@ }, { "$ref": "#/components/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 +393835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -318411,7 +393892,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +394644,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 +394880,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -319361,7 +394923,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +394944,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 +395099,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +395131,6 @@ }, { "$ref": "#/components/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 +395157,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -319541,7 +395214,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +395714,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 +395907,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -320216,7 +395950,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +395971,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 +396126,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +396158,6 @@ }, { "$ref": "#/components/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 +396184,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -320396,7 +396241,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +397110,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 +397400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -321542,7 +397443,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +397483,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 +397676,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +397708,6 @@ }, { "$ref": "#/components/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 +397734,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -321741,7 +397791,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +398124,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 +398301,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322233,7 +398344,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +398366,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 +398523,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +398555,6 @@ }, { "$ref": "#/components/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 +398581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322414,7 +398638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +398867,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 +399044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322802,7 +399087,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +399109,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 +399266,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +399298,6 @@ }, { "$ref": "#/components/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 +399324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322983,7 +399381,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +399609,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 +399786,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323370,7 +399829,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +399850,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 +400005,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +400037,6 @@ }, { "$ref": "#/components/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 +400063,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323550,7 +400120,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +400401,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 +400574,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323975,7 +400617,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +400638,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 +400793,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +400825,6 @@ }, { "$ref": "#/components/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 +400851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324155,7 +400908,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +401127,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 +401304,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324533,7 +401347,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +401368,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 +401523,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +401555,6 @@ }, { "$ref": "#/components/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 +401581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324713,7 +401638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +401938,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", + "programName", + "programTypeDescriptor", + "namespace", + "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 +402126,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -325167,7 +402169,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +402190,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 +402345,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +402377,6 @@ }, { "$ref": "#/components/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 +402403,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -325347,7 +402460,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +403052,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 +403242,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -326100,7 +403285,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +403306,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 +403461,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +403493,6 @@ }, { "$ref": "#/components/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 +403519,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -326280,7 +403576,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +404122,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": [ + "questionCode", + "namespace", + "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 +404308,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -326988,7 +404351,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +404372,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 +404527,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +404559,6 @@ }, { "$ref": "#/components/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 +404585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -327168,7 +404642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +404924,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 +405097,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -327594,7 +405140,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +405161,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 +405316,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +405348,6 @@ }, { "$ref": "#/components/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 +405374,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -327774,7 +405431,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +405723,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": [ + "personId", + "sourceSystemDescriptor", + "namespace", + "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 +405911,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328220,7 +405954,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +405975,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 +406130,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +406162,6 @@ }, { "$ref": "#/components/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 +406188,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328400,7 +406245,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +406520,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": [ + "staffUniqueId", + "namespace", + "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 +406693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328819,7 +406736,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +406757,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 +406912,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +406944,6 @@ }, { "$ref": "#/components/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 +406970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328999,7 +407027,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +407547,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 +407801,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -329749,7 +407844,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +407865,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 +408020,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +408052,6 @@ }, { "$ref": "#/components/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 +408078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -329929,7 +408135,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +408749,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", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor", + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ], + "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 +409104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -330810,7 +409147,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +409168,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 +409323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +409355,6 @@ }, { "$ref": "#/components/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 +409381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -330990,7 +409438,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +409846,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", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "namespace", + "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 +410064,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -331572,7 +410107,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +410128,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 +410283,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +410315,6 @@ }, { "$ref": "#/components/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 +410341,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -331752,7 +410398,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +410719,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 +410907,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332227,7 +410950,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +410971,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 +411126,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +411158,6 @@ }, { "$ref": "#/components/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 +411184,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332407,7 +411241,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +411569,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": [ + "personId", + "sourceSystemDescriptor", + "namespace", + "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 +411772,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332899,7 +411815,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +411836,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 +411991,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +412023,6 @@ }, { "$ref": "#/components/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 +412049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333079,7 +412106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +412417,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": [ + "staffUniqueId", + "namespace", + "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 +412605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333544,7 +412648,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +412669,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 +412824,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +412856,6 @@ }, { "$ref": "#/components/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 +412882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333724,7 +412939,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +413273,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": [ + "surveyResponseIdentifier", + "namespace", + "surveyIdentifier", + "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 +413455,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334211,7 +413498,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +413519,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 +413674,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +413706,6 @@ }, { "$ref": "#/components/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 +413732,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334391,7 +413789,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +414162,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 +414414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334992,7 +414457,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +414478,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 +414633,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +414665,6 @@ }, { "$ref": "#/components/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 +414691,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335172,7 +414748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +415189,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 +415398,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335803,7 +415441,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +415462,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 +415617,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +415649,6 @@ }, { "$ref": "#/components/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 +415675,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335983,7 +415732,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +415978,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 +416155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336388,7 +416198,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +416220,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 +416377,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +416409,6 @@ }, { "$ref": "#/components/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 +416435,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336569,7 +416492,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +416721,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 +416898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336957,7 +416941,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +416963,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 +417120,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +417152,6 @@ }, { "$ref": "#/components/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 +417178,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337138,7 +417235,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +417463,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 +417640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337525,7 +417683,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +417704,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 +417859,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +417891,6 @@ }, { "$ref": "#/components/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 +417917,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337705,7 +417974,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +418215,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 +418392,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338105,7 +418435,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +418470,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 +418653,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +418685,6 @@ }, { "$ref": "#/components/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 +418711,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338299,7 +418768,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +419024,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 +419201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338714,7 +419244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +419280,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 +419465,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +419497,6 @@ }, { "$ref": "#/components/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 +419523,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338909,7 +419580,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +419822,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 +419999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339310,7 +420042,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +420063,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 +420218,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +420250,6 @@ }, { "$ref": "#/components/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 +420276,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339490,7 +420333,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +420560,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 +420737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339876,7 +420780,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +420801,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 +420956,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +420988,6 @@ }, { "$ref": "#/components/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 +421014,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340056,7 +421071,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +421311,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 +421488,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340455,7 +421531,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +421565,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 +421746,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +421778,6 @@ }, { "$ref": "#/components/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 +421804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340648,7 +421861,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +422101,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 +422278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341047,7 +422321,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +422342,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 +422497,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +422529,6 @@ }, { "$ref": "#/components/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 +422555,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341227,7 +422612,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +422839,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 +423016,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341613,7 +423059,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +423080,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 +423235,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +423267,6 @@ }, { "$ref": "#/components/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 +423293,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341793,7 +423350,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +423577,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 +423754,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342179,7 +423797,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +423818,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 +423973,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +424005,6 @@ }, { "$ref": "#/components/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 +424031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342359,7 +424088,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +424315,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 +424492,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342745,7 +424535,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +424556,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 +424711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +424743,6 @@ }, { "$ref": "#/components/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 +424769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342925,7 +424826,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +425065,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 +425242,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343323,7 +425285,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +425318,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 +425497,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +425529,6 @@ }, { "$ref": "#/components/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 +425555,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343515,7 +425612,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +425874,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 +426051,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343936,7 +426094,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +426138,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 +426339,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +426371,6 @@ }, { "$ref": "#/components/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 +426397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344139,7 +426454,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +426704,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 +426881,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344548,7 +426924,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +426945,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 +427100,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +427132,6 @@ }, { "$ref": "#/components/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 +427158,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344728,7 +427215,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +427442,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 +427619,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345114,7 +427662,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +427683,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 +427838,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +427870,6 @@ }, { "$ref": "#/components/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 +427896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345294,7 +427953,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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..a4a77991b 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": { @@ -1248,9 +1308,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." }, @@ -1434,9 +1491,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 +2159,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 +2336,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2264,7 +2379,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +2400,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 +2555,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2587,6 @@ }, { "$ref": "#/components/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 +2613,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2444,7 +2670,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +2901,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 +3078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2834,7 +3121,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +3146,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 +3193,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 +3236,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 +3255,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 +3292,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 +3309,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$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 +3680,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 +3857,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3433,7 +3900,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +3946,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 +3972,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 +3993,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 +4580,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 +4750,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4103,7 +4793,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +4814,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 +4969,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +5001,6 @@ }, { "$ref": "#/components/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 +5027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4283,7 +5084,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +5311,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 +5488,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4669,7 +5531,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +5555,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 +5716,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +5748,6 @@ }, { "$ref": "#/components/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 +5774,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4852,7 +5831,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +6061,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 +6238,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5241,7 +6281,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +6302,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 +6457,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +6489,6 @@ }, { "$ref": "#/components/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 +6515,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5421,7 +6572,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +6919,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 +7111,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5937,7 +7154,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +7176,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 +7333,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +7365,6 @@ }, { "$ref": "#/components/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 +7391,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6118,7 +7448,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +7699,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 +7876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6528,7 +7919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +7954,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 +8137,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +8169,6 @@ }, { "$ref": "#/components/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 +8195,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6722,7 +8252,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +8506,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 +8683,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7135,7 +8726,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +8760,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 +8941,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +8973,6 @@ }, { "$ref": "#/components/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 +8999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7328,7 +9056,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +9299,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 +9476,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7730,7 +9519,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +9543,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 +9704,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +9736,6 @@ }, { "$ref": "#/components/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 +9762,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7913,7 +9819,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +10070,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 +10247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8323,7 +10290,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +10332,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 +10529,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +10561,6 @@ }, { "$ref": "#/components/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 +10587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8524,7 +10644,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +10913,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 +11090,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8952,7 +11133,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +11175,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 +11372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +11404,6 @@ }, { "$ref": "#/components/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 +11430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9153,7 +11487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +11736,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 +11913,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9561,7 +11956,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +11978,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 +12135,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +12167,6 @@ }, { "$ref": "#/components/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 +12193,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9742,7 +12250,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +12491,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 +12668,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10142,7 +12711,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +12745,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 +12926,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +12958,6 @@ }, { "$ref": "#/components/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 +12984,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10335,7 +13041,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +13281,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 +13458,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10734,7 +13501,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +13522,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 +13677,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +13709,6 @@ }, { "$ref": "#/components/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 +13735,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10914,7 +13792,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +14022,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 +14199,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11303,7 +14242,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +14266,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 +14427,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +14459,6 @@ }, { "$ref": "#/components/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 +14485,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11486,7 +14542,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +17200,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 +17496,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14426,7 +17539,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +17560,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 +17715,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +17747,6 @@ }, { "$ref": "#/components/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 +17773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14606,7 +17830,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +18148,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 +18325,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15083,7 +18368,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +18389,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 +18544,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +18576,6 @@ }, { "$ref": "#/components/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 +18602,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15263,7 +18659,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +18886,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 +19063,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15649,7 +19106,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +19127,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 +19282,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +19314,6 @@ }, { "$ref": "#/components/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 +19340,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15829,7 +19397,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +19848,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": [ + "applicationEventTypeDescriptor", + "applicantProfileIdentifier", + "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 +20098,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16490,7 +20141,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +20162,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 +20317,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +20349,6 @@ }, { "$ref": "#/components/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 +20375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16670,7 +20432,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +20692,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 +20869,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17089,7 +20912,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +20933,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 +21088,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +21120,6 @@ }, { "$ref": "#/components/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 +21146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17269,7 +21203,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +21430,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 +21607,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17655,7 +21650,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +21671,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 +21826,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +21858,6 @@ }, { "$ref": "#/components/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 +21884,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17835,7 +21941,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +22762,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 +23039,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18908,7 +23082,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +23103,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 +23258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +23290,6 @@ }, { "$ref": "#/components/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 +23316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19088,7 +23373,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +23886,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 +24074,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19755,7 +24117,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +24138,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 +24293,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +24325,6 @@ }, { "$ref": "#/components/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 +24351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19935,7 +24408,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +24865,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", + "namespace", + "assigningEducationOrganizationId" + ], + "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 +25038,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20536,7 +25081,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +25102,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 +25257,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +25289,6 @@ }, { "$ref": "#/components/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 +25315,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20716,7 +25372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +25711,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 +25869,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21189,7 +25912,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +25933,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 +26088,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +26120,6 @@ }, { "$ref": "#/components/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 +26146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21369,7 +26203,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +26414,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 +26591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21739,7 +26634,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +26656,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 +26813,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +26845,6 @@ }, { "$ref": "#/components/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 +26871,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21920,7 +26928,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +27157,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 +27334,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22308,7 +27377,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +27399,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 +27556,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +27588,6 @@ }, { "$ref": "#/components/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 +27614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22489,7 +27671,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +27900,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 +28077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22877,7 +28120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +28142,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 +28299,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +28331,6 @@ }, { "$ref": "#/components/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 +28357,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23058,7 +28414,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +28643,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 +28820,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23446,7 +28863,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +28885,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 +29042,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +29074,6 @@ }, { "$ref": "#/components/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 +29100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23627,7 +29157,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +29674,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", + "namespace", + "identificationCode" + ], + "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 +29887,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24333,7 +29930,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +29952,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 +30109,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +30141,6 @@ }, { "$ref": "#/components/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 +30167,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24514,7 +30224,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +30472,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 +30649,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24921,7 +30692,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +30715,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 +30874,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +30906,6 @@ }, { "$ref": "#/components/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 +30932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25103,7 +30989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +31223,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 +31400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25496,7 +31443,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +31469,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 +31634,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +31666,6 @@ }, { "$ref": "#/components/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 +31692,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25681,7 +31749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +32193,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 +32388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26296,7 +32431,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +32452,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 +32607,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +32639,6 @@ }, { "$ref": "#/components/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 +32665,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26476,7 +32722,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +34229,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 +34471,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28206,7 +34514,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +34536,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 +34693,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +34725,6 @@ }, { "$ref": "#/components/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 +34751,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28387,7 +34808,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +35088,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 +35265,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28826,7 +35308,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +35330,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 +35487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +35519,6 @@ }, { "$ref": "#/components/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 +35545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29007,7 +35602,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +35838,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 +36015,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29402,7 +36058,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +36087,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 +36258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +36290,6 @@ }, { "$ref": "#/components/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 +36316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29590,7 +36373,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +36612,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 +36789,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29988,7 +36832,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +36857,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 +37020,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +37052,6 @@ }, { "$ref": "#/components/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 +37078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30172,7 +37135,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +37368,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 +37545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30564,7 +37588,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +37611,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 +37770,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +37802,6 @@ }, { "$ref": "#/components/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 +37828,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30746,7 +37885,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +38116,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 +38293,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31136,7 +38336,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +38359,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 +38518,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +38550,6 @@ }, { "$ref": "#/components/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 +38576,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31318,7 +38633,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +38923,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 +39073,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31740,7 +39116,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +39137,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 +39292,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +39324,6 @@ }, { "$ref": "#/components/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 +39350,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31920,7 +39407,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +39616,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 +39793,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32288,7 +39836,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +39858,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 +40015,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +40047,6 @@ }, { "$ref": "#/components/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 +40073,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32469,7 +40130,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +40358,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 +40535,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32856,7 +40578,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +40599,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 +40754,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +40786,6 @@ }, { "$ref": "#/components/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 +40812,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33036,7 +40869,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +41355,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 +41530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33679,7 +41573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +41594,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 +41749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +41781,6 @@ }, { "$ref": "#/components/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 +41807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33859,7 +41864,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +42094,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 +42271,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34248,7 +42314,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +42335,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 +42490,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +42522,6 @@ }, { "$ref": "#/components/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 +42548,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34428,7 +42605,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +42929,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", + "schoolId", + "schoolYear", + "date" + ], + "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 +43100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34895,7 +43143,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +43164,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 +43319,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +43351,6 @@ }, { "$ref": "#/components/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 +43377,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35075,7 +43434,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +43652,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 +43829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35452,7 +43872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +43893,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 +44048,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +44080,6 @@ }, { "$ref": "#/components/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 +44106,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35632,7 +44163,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +44390,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 +44567,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36018,7 +44610,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +44631,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 +44786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +44818,6 @@ }, { "$ref": "#/components/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 +44844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36198,7 +44901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +45249,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 +45414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36688,7 +45457,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +45478,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 +45633,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +45665,6 @@ }, { "$ref": "#/components/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 +45691,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36868,7 +45748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +45966,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 +46143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37245,7 +46186,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +46207,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 +46362,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +46394,6 @@ }, { "$ref": "#/components/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 +46420,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37425,7 +46477,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +47290,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 +47529,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38442,7 +47572,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +47593,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 +47748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +47780,6 @@ }, { "$ref": "#/components/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 +47806,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38622,7 +47863,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +48200,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 +48376,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39111,7 +48419,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +48440,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 +48595,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +48627,6 @@ }, { "$ref": "#/components/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 +48653,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39291,7 +48710,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +48934,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 +49111,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39674,7 +49154,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +49175,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 +49330,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +49362,6 @@ }, { "$ref": "#/components/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 +49388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39854,7 +49445,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +49746,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 +49916,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40306,7 +49959,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +49980,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 +50135,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +50167,6 @@ }, { "$ref": "#/components/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 +50193,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40486,7 +50250,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +53298,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 +53706,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43928,7 +53749,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +53770,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 +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" @@ -44016,15 +53957,6 @@ }, { "$ref": "#/components/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 +53983,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44108,7 +54040,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +54438,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 +54615,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44665,7 +54658,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +54685,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 +54852,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +54884,6 @@ }, { "$ref": "#/components/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 +54910,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44851,7 +54967,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +55433,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 +55697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45547,7 +55740,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +55761,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 +55916,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +55948,6 @@ }, { "$ref": "#/components/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 +55974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45727,7 +56031,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +56306,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 +56483,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46161,7 +56526,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +56547,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 +56702,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +56734,6 @@ }, { "$ref": "#/components/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 +56760,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46341,7 +56817,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +57044,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 +57221,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46727,7 +57264,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +57285,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 +57440,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +57472,6 @@ }, { "$ref": "#/components/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 +57498,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46907,7 +57555,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +57882,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 +58072,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47405,7 +58115,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +58136,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 +58291,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +58323,6 @@ }, { "$ref": "#/components/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 +58349,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47585,7 +58406,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +58639,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 +58816,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47977,7 +58859,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +58880,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 +59035,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +59067,6 @@ }, { "$ref": "#/components/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 +59093,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48157,7 +59150,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +59377,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 +59554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48543,7 +59597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +59618,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 +59773,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +59805,6 @@ }, { "$ref": "#/components/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 +59831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48723,7 +59888,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +60118,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 +60295,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49112,7 +60338,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +60362,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 +60523,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +60555,6 @@ }, { "$ref": "#/components/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 +60581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49295,7 +60638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +60868,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 +61045,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49684,7 +61088,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +61109,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 +61264,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +61296,6 @@ }, { "$ref": "#/components/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 +61322,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49864,7 +61379,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +62018,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 +62262,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50728,7 +62305,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +62326,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 +62481,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +62513,6 @@ }, { "$ref": "#/components/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 +62539,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50908,7 +62596,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +63433,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 +63687,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51976,7 +63730,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +63751,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 +63906,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +63938,6 @@ }, { "$ref": "#/components/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 +63964,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52156,7 +64021,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +64318,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 +64495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52612,7 +64538,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +64572,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 +64753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +64785,6 @@ }, { "$ref": "#/components/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 +64811,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52805,7 +64868,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +65121,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 +65298,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53217,7 +65341,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +65375,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 +65556,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +65588,6 @@ }, { "$ref": "#/components/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 +65614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53410,7 +65671,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +65916,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 +66093,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53814,7 +66136,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +66162,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 +66327,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +66359,6 @@ }, { "$ref": "#/components/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 +66385,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53999,7 +66442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +66762,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 +66911,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54450,7 +66954,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +66977,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 +67136,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +67168,6 @@ }, { "$ref": "#/components/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 +67194,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54632,7 +67251,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +67469,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 +67646,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55009,7 +67689,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +67713,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 +67874,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +67906,6 @@ }, { "$ref": "#/components/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 +67932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55192,7 +67989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +68220,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 +68397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55582,7 +68440,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +68462,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 +68619,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +68651,6 @@ }, { "$ref": "#/components/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 +68677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55763,7 +68734,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +68963,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 +69140,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56151,7 +69183,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +69205,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 +69362,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +69394,6 @@ }, { "$ref": "#/components/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 +69420,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56332,7 +69477,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +69707,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 +69884,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56721,7 +69927,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +69950,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 +70109,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +70141,6 @@ }, { "$ref": "#/components/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 +70167,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56903,7 +70224,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +70619,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 +70796,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57457,7 +70839,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +70861,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 +71018,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +71050,6 @@ }, { "$ref": "#/components/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 +71076,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57638,7 +71133,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +72104,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 +72550,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59042,7 +72593,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +72614,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 +72769,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +72801,6 @@ }, { "$ref": "#/components/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 +72827,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59222,7 +72884,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +73302,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 +73530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59845,7 +73573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +73594,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 +73749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +73781,6 @@ }, { "$ref": "#/components/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 +73807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60025,7 +73864,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +74992,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 +75491,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61639,7 +75534,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +75555,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 +75710,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +75742,6 @@ }, { "$ref": "#/components/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 +75768,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61819,7 +75825,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +76102,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 +76279,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62255,7 +76322,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +76350,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 +76519,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +76551,6 @@ }, { "$ref": "#/components/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 +76577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62442,7 +76634,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +76951,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 +77134,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62919,7 +77177,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +77199,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 +77356,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +77388,6 @@ }, { "$ref": "#/components/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 +77414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63100,7 +77471,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +77783,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 +77957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63563,7 +78000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +78021,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 +78176,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +78208,6 @@ }, { "$ref": "#/components/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 +78234,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63743,7 +78291,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +78516,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 +78693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64127,7 +78736,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +78757,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 +78912,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +78944,6 @@ }, { "$ref": "#/components/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 +78970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64307,7 +79027,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +80823,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 +81077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66344,7 +81120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +81142,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 +81299,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +81331,6 @@ }, { "$ref": "#/components/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 +81357,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66525,7 +81414,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +81703,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 +81880,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66973,7 +81923,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +81943,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 +82096,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +82128,6 @@ }, { "$ref": "#/components/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 +82154,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67152,7 +82211,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +82437,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 +82614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67537,7 +82657,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +82678,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 +82833,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +82865,6 @@ }, { "$ref": "#/components/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 +82891,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67717,7 +82948,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +83175,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 +83352,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68103,7 +83395,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +83416,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 +83571,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +83603,6 @@ }, { "$ref": "#/components/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 +83629,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68283,7 +83686,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +83913,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 +84090,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68669,7 +84133,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +84154,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 +84309,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +84341,6 @@ }, { "$ref": "#/components/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 +84367,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68849,7 +84424,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +84678,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 +84855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69262,7 +84898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +84946,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 +85155,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +85187,6 @@ }, { "$ref": "#/components/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 +85213,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69469,7 +85270,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +85527,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 +85704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69885,7 +85747,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +85771,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 +85932,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +85964,6 @@ }, { "$ref": "#/components/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 +85990,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70068,7 +86047,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +86283,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 +86460,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70463,7 +86503,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +86530,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 +86697,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +86729,6 @@ }, { "$ref": "#/components/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 +86755,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70649,7 +86812,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +87051,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 +87228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71047,7 +87271,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +87298,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 +87465,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +87497,6 @@ }, { "$ref": "#/components/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 +87523,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71233,7 +87580,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +87819,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 +87996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71631,7 +88039,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +88066,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 +88233,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +88265,6 @@ }, { "$ref": "#/components/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 +88291,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71817,7 +88348,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +88595,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 +88772,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72223,7 +88815,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +88850,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 +89033,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +89065,6 @@ }, { "$ref": "#/components/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 +89091,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72417,7 +89148,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +89724,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 +89933,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73174,7 +89976,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +90000,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 +90161,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +90193,6 @@ }, { "$ref": "#/components/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 +90219,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73357,7 +90276,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +90528,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 +90705,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73768,7 +90748,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +90772,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 +90933,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +90965,6 @@ }, { "$ref": "#/components/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 +90991,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73951,7 +91048,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +92448,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 +92829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75689,7 +92872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +92896,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 +93057,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +93089,6 @@ }, { "$ref": "#/components/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 +93115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75872,7 +93172,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +94270,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 +94554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77236,7 +94597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +94624,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 +94791,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +94823,6 @@ }, { "$ref": "#/components/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 +94849,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77422,7 +94906,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +95220,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 +95397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77895,7 +95440,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +95461,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 +95616,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +95648,6 @@ }, { "$ref": "#/components/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 +95674,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78075,7 +95731,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +96023,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 +96203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78519,7 +96246,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +96267,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 +96422,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +96454,6 @@ }, { "$ref": "#/components/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 +96480,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78699,7 +96537,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +96758,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 +96935,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79079,7 +96978,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +97000,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 +97157,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +97189,6 @@ }, { "$ref": "#/components/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 +97215,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79260,7 +97272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +97501,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 +97678,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79648,7 +97721,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +97743,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 +97900,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +97932,6 @@ }, { "$ref": "#/components/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 +97958,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79829,7 +98015,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +98244,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 +98421,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80217,7 +98464,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +98486,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 +98643,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +98675,6 @@ }, { "$ref": "#/components/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 +98701,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80398,7 +98758,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +99608,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 +99917,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81539,7 +99960,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +99982,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 +100139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +100171,6 @@ }, { "$ref": "#/components/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 +100197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81720,7 +100254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +100578,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 +100755,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82203,7 +100798,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +100824,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 +100989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +101021,6 @@ }, { "$ref": "#/components/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 +101047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82388,7 +101104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +101352,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 +101529,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82795,7 +101572,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +101609,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 +101796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +101828,6 @@ }, { "$ref": "#/components/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 +101854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82991,7 +101911,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +102185,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 +102347,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83414,7 +102390,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +102411,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 +102566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +102598,6 @@ }, { "$ref": "#/components/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 +102624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83594,7 +102681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +102901,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 +103078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83973,7 +103121,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +103142,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 +103297,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +103329,6 @@ }, { "$ref": "#/components/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 +103355,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84153,7 +103412,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +103639,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 +103816,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84539,7 +103859,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +103880,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 +104035,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +104067,6 @@ }, { "$ref": "#/components/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 +104093,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84719,7 +104150,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +104380,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 +104557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85108,7 +104600,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +104624,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 +104785,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +104817,6 @@ }, { "$ref": "#/components/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 +104843,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85291,7 +104900,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +105130,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 +105307,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85680,7 +105350,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +105371,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 +105526,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +105558,6 @@ }, { "$ref": "#/components/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 +105584,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85860,7 +105641,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +105869,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 +106046,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86247,7 +106089,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +106111,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 +106268,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +106300,6 @@ }, { "$ref": "#/components/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 +106326,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86428,7 +106383,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +106712,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 +106887,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86902,7 +106930,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +106951,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 +107106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +107138,6 @@ }, { "$ref": "#/components/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 +107164,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87082,7 +107221,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +107437,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 +107614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87457,7 +107657,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +107679,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 +107836,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +107868,6 @@ }, { "$ref": "#/components/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 +107894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87638,7 +107951,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +108183,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 +108360,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88029,7 +108403,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +108428,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 +108591,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +108623,6 @@ }, { "$ref": "#/components/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 +108649,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88213,7 +108706,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +108941,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 +109118,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88607,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" @@ -88632,6 +109186,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 +109349,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +109381,6 @@ }, { "$ref": "#/components/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 +109407,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88791,7 +109464,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +109702,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 +109879,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89188,7 +109922,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +109950,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 +110119,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +110151,6 @@ }, { "$ref": "#/components/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 +110177,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89375,7 +110234,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +110475,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 +110652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89775,7 +110695,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +110723,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 +110892,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +110924,6 @@ }, { "$ref": "#/components/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 +110950,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89962,7 +111007,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +111248,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 +111425,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90362,7 +111468,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +111496,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 +111665,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +111697,6 @@ }, { "$ref": "#/components/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 +111723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90549,7 +111780,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +112014,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 +112191,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90942,7 +112234,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +112255,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 +112410,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +112442,6 @@ }, { "$ref": "#/components/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 +112468,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91122,7 +112525,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +113172,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 +113391,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91965,7 +113434,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +113455,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 +113610,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +113642,6 @@ }, { "$ref": "#/components/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 +113668,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92145,7 +113725,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +113986,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 +114163,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92565,7 +114206,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +114227,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 +114382,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +114414,6 @@ }, { "$ref": "#/components/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 +114440,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92745,7 +114497,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +114724,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 +114901,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93131,7 +114944,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +114965,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 +115120,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +115152,6 @@ }, { "$ref": "#/components/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 +115178,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93311,7 +115235,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +115846,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 +116078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94136,7 +116121,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +116142,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 +116297,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +116329,6 @@ }, { "$ref": "#/components/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 +116355,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94316,7 +116412,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +116678,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 +116855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94741,7 +116898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +116920,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 +117077,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +117109,6 @@ }, { "$ref": "#/components/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 +117135,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94922,7 +117192,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +117428,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 +117605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95317,7 +117648,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +117677,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 +117848,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +117880,6 @@ }, { "$ref": "#/components/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 +117906,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95505,7 +117963,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +118206,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 +118383,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95907,7 +118426,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +118455,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 +118626,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +118658,6 @@ }, { "$ref": "#/components/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 +118684,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96095,7 +118741,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +118976,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 +119153,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96489,7 +119196,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +119217,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 +119372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +119404,6 @@ }, { "$ref": "#/components/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 +119430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96669,7 +119487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +119718,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 +119895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97059,7 +119938,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +119963,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 +120126,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +120158,6 @@ }, { "$ref": "#/components/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 +120184,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97243,7 +120241,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +121110,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 +121383,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98372,7 +121426,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +121447,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 +121602,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +121634,6 @@ }, { "$ref": "#/components/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 +121660,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98552,7 +121717,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +122015,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 +122192,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99009,7 +122235,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +122256,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 +122411,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +122443,6 @@ }, { "$ref": "#/components/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 +122469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99189,7 +122526,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +122771,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 +122948,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99593,7 +122991,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +123030,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 +123221,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +123253,6 @@ }, { "$ref": "#/components/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 +123279,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99791,7 +123336,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +123618,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": [ + "educationOrganizationIdentificationSystemDescriptor", + "educationOrganizationId" + ], + "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 +123777,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100214,7 +123820,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +123841,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 +123996,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +124028,6 @@ }, { "$ref": "#/components/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 +124054,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100394,7 +124111,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +124329,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 +124506,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100771,7 +124549,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +124570,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 +124725,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +124757,6 @@ }, { "$ref": "#/components/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 +124783,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100951,7 +124840,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +125137,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 +125311,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101399,7 +125354,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +125375,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 +125530,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +125562,6 @@ }, { "$ref": "#/components/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 +125588,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101579,7 +125645,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +125924,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 +126083,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101999,7 +126126,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +126147,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 +126302,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +126334,6 @@ }, { "$ref": "#/components/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 +126360,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102179,7 +126417,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +127397,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 +127852,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103601,7 +127895,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +127916,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 +128071,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +128103,6 @@ }, { "$ref": "#/components/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 +128129,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103781,7 +128186,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +128438,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 +128579,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104156,7 +128622,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +128643,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 +128798,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +128830,6 @@ }, { "$ref": "#/components/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 +128856,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104336,7 +128913,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +129128,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 +129305,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104710,7 +129348,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +129373,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 +129536,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +129568,6 @@ }, { "$ref": "#/components/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 +129594,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104894,7 +129651,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +130935,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 +131108,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106338,7 +131151,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +131173,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 +131330,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +131362,6 @@ }, { "$ref": "#/components/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 +131388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106519,7 +131445,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +131699,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 +131876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106932,7 +131919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +131953,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 +132134,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +132166,6 @@ }, { "$ref": "#/components/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 +132192,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107125,7 +132249,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +132614,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 +132790,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107642,7 +132833,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +132854,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 +133009,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +133041,6 @@ }, { "$ref": "#/components/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 +133067,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107822,7 +133124,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +133349,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 +133526,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108206,7 +133569,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +133591,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 +133748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +133780,6 @@ }, { "$ref": "#/components/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 +133806,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108387,7 +133863,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +134096,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 +134273,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108779,7 +134316,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +134342,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 +134507,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +134539,6 @@ }, { "$ref": "#/components/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 +134565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108964,7 +134622,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +134854,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 +135031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109355,7 +135074,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +135095,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 +135250,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +135282,6 @@ }, { "$ref": "#/components/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 +135308,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109535,7 +135365,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +135592,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 +135769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109921,7 +135812,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +135833,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 +135988,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +136020,6 @@ }, { "$ref": "#/components/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 +136046,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110101,7 +136103,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +136330,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 +136507,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110487,7 +136550,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +136571,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 +136726,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +136758,6 @@ }, { "$ref": "#/components/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 +136784,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110667,7 +136841,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +137068,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 +137245,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111053,7 +137288,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +137309,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 +137464,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +137496,6 @@ }, { "$ref": "#/components/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 +137522,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111233,7 +137579,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +137810,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 +137987,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111623,7 +138030,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +138055,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 +138218,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +138250,6 @@ }, { "$ref": "#/components/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 +138276,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111807,7 +138333,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +138568,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 +138745,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112201,7 +138788,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +138813,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 +138976,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +139008,6 @@ }, { "$ref": "#/components/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 +139034,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112385,7 +139091,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +139326,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 +139503,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112779,7 +139546,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +139571,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 +139734,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +139766,6 @@ }, { "$ref": "#/components/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 +139792,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112963,7 +139849,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +140080,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 +140257,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113353,7 +140300,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +140321,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 +140476,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +140508,6 @@ }, { "$ref": "#/components/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 +140534,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113533,7 +140591,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +140818,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 +140995,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113919,7 +141038,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +141059,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 +141214,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +141246,6 @@ }, { "$ref": "#/components/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 +141272,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114099,7 +141329,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +141556,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 +141733,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114485,7 +141776,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +141797,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 +141952,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +141984,6 @@ }, { "$ref": "#/components/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 +142010,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114665,7 +142067,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +142294,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 +142471,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115051,7 +142514,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +142535,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 +142690,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +142722,6 @@ }, { "$ref": "#/components/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 +142748,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115231,7 +142805,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +143626,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": [ + "evaluationElementTitle", + "educationOrganizationId", + "evaluationDate", + "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 +143974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116328,7 +144017,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +144038,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 +144193,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +144225,6 @@ }, { "$ref": "#/components/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 +144251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116508,7 +144308,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +144947,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": [ + "evaluationElementTitle", + "educationOrganizationId", + "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 +145237,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117380,7 +145280,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +145301,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 +145456,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +145488,6 @@ }, { "$ref": "#/components/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 +145514,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117560,7 +145571,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +146339,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": [ + "evaluationObjectiveTitle", + "evaluationTitle", + "educationOrganizationId", + "evaluationDate", + "evaluationPeriodDescriptor", + "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 +146640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118563,7 +146683,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +146704,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 +146859,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +146891,6 @@ }, { "$ref": "#/components/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 +146917,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118743,7 +146974,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +147585,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": [ + "evaluationObjectiveTitle", + "educationOrganizationId", + "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 +147867,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119585,7 +147910,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +147931,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 +148086,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +148118,6 @@ }, { "$ref": "#/components/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 +148144,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119765,7 +148201,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +148480,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 +148657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120203,7 +148700,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +148721,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 +148876,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +148908,6 @@ }, { "$ref": "#/components/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 +148934,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120383,7 +148991,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +149218,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 +149395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120769,7 +149438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +149459,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 +149614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +149646,6 @@ }, { "$ref": "#/components/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 +149672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120949,7 +149729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +149956,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 +150133,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121335,7 +150176,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +150197,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 +150352,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +150384,6 @@ }, { "$ref": "#/components/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 +150410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121515,7 +150467,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +151425,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": [ + "evaluationDate", + "evaluationTitle", + "performanceEvaluationTypeDescriptor", + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "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 +151767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122755,7 +151810,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +151831,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 +151986,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +152018,6 @@ }, { "$ref": "#/components/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 +152044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122935,7 +152101,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +152590,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 +152848,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123634,7 +152891,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +152913,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 +153070,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +153102,6 @@ }, { "$ref": "#/components/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 +153128,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123815,7 +153185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +153446,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 +153623,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124235,7 +153666,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +153687,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 +153842,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +153874,6 @@ }, { "$ref": "#/components/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 +153900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124415,7 +153957,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +154491,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": [ + "evaluationTitle", + "educationOrganizationId", + "evaluationPeriodDescriptor", + "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 +154756,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125169,7 +154799,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +154820,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 +154975,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +155007,6 @@ }, { "$ref": "#/components/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 +155033,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125349,7 +155090,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +155364,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 +155541,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125782,7 +155584,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +155606,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 +155763,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +155795,6 @@ }, { "$ref": "#/components/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 +155821,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125963,7 +155878,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +156106,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 +156283,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126350,7 +156326,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +156347,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 +156502,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +156534,6 @@ }, { "$ref": "#/components/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 +156560,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126530,7 +156617,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +156844,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 +157021,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126916,7 +157064,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +157085,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 +157240,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +157272,6 @@ }, { "$ref": "#/components/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 +157298,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127096,7 +157355,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +157586,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 +157763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127486,7 +157806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +157831,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 +157994,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +158026,6 @@ }, { "$ref": "#/components/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 +158052,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127670,7 +158109,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +158353,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 +158530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128073,7 +158573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +158607,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 +158788,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +158820,6 @@ }, { "$ref": "#/components/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 +158846,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128266,7 +158903,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +159221,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 +159395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128735,7 +159438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +159459,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 +159614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +159646,6 @@ }, { "$ref": "#/components/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 +159672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128915,7 +159729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160095,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", + "studentUniqueId", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "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 +160328,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129465,7 +160371,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +160392,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 +160547,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +160579,6 @@ }, { "$ref": "#/components/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 +160605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129645,7 +160662,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +161148,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 +161374,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130333,7 +161417,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +161438,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 +161593,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +161625,6 @@ }, { "$ref": "#/components/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 +161651,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130513,7 +161708,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +161959,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 +162136,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130923,7 +162179,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +162200,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 +162355,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +162387,6 @@ }, { "$ref": "#/components/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 +162413,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131103,7 +162470,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +162802,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 +162993,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131603,7 +163036,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +163057,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 +163212,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +163244,6 @@ }, { "$ref": "#/components/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 +163270,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131783,7 +163327,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +163560,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 +163737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132175,7 +163780,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +163801,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 +163956,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +163988,6 @@ }, { "$ref": "#/components/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 +164014,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132355,7 +164071,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +164298,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 +164475,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132741,7 +164518,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +164539,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 +164694,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +164726,6 @@ }, { "$ref": "#/components/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 +164752,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132921,7 +164809,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +165097,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 +165247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133341,7 +165290,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +165311,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 +165466,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +165498,6 @@ }, { "$ref": "#/components/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 +165524,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133521,7 +165581,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +165850,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 +166000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133922,7 +166043,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +166064,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 +166219,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +166251,6 @@ }, { "$ref": "#/components/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 +166277,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134102,7 +166334,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +166542,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 +166719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134469,7 +166762,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +166783,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 +166938,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +166970,6 @@ }, { "$ref": "#/components/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 +166996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134649,7 +167053,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +167280,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 +167457,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135035,7 +167500,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +167521,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 +167676,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +167708,6 @@ }, { "$ref": "#/components/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 +167734,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135215,7 +167791,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +168533,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 +168895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136290,7 +168938,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +168959,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 +169114,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +169146,6 @@ }, { "$ref": "#/components/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 +169172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136470,7 +169229,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +169590,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 +169767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136990,7 +169810,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +169859,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 +170070,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +170102,6 @@ }, { "$ref": "#/components/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 +170128,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137198,7 +170185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +170446,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 +170623,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137618,7 +170666,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +170693,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 +170860,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +170892,6 @@ }, { "$ref": "#/components/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 +170918,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137804,7 +170975,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +171209,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 +171386,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138197,7 +171429,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +171451,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 +171608,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +171640,6 @@ }, { "$ref": "#/components/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 +171666,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138378,7 +171723,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +172320,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 +172604,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139240,7 +172647,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +172669,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 +172826,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +172858,6 @@ }, { "$ref": "#/components/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 +172884,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139421,7 +172941,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +173237,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 +173414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139876,7 +173457,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +173479,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 +173636,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +173668,6 @@ }, { "$ref": "#/components/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 +173694,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -140057,7 +173751,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +174491,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": [ + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "beginDate", + "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 +174829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141072,7 +174872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +174894,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 +175051,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +175083,6 @@ }, { "$ref": "#/components/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 +175109,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141253,7 +175166,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +175478,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 +175655,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141724,7 +175698,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +175721,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 +175880,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +175912,6 @@ }, { "$ref": "#/components/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 +175938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141906,7 +175995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +176382,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 +176589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142472,7 +176632,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +176655,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 +176814,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +176846,6 @@ }, { "$ref": "#/components/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 +176872,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142654,7 +176929,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +177174,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 +177351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143058,7 +177394,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +177416,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 +177573,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +177605,6 @@ }, { "$ref": "#/components/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 +177631,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143239,7 +177688,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +178969,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 +179160,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144688,7 +179203,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +179225,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 +179382,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +179414,6 @@ }, { "$ref": "#/components/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 +179440,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144869,7 +179497,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +179749,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 +179926,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145280,7 +179969,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +179992,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 +180151,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +180183,6 @@ }, { "$ref": "#/components/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 +180209,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145462,7 +180266,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +180495,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 +180672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145850,7 +180715,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +180736,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 +180891,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +180923,6 @@ }, { "$ref": "#/components/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 +180949,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146030,7 +181006,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +181233,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 +181410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146416,7 +181453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +181474,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 +181629,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +181661,6 @@ }, { "$ref": "#/components/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 +181687,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146596,7 +181744,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +181971,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 +182148,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146982,7 +182191,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +182212,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 +182367,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +182399,6 @@ }, { "$ref": "#/components/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 +182425,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147162,7 +182482,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +182709,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 +182886,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147548,7 +182929,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +182950,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 +183105,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +183137,6 @@ }, { "$ref": "#/components/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 +183163,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147728,7 +183220,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +183447,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 +183624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148114,7 +183667,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +183688,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 +183843,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +183875,6 @@ }, { "$ref": "#/components/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 +183901,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148294,7 +183958,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +184356,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 +184572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148880,7 +184615,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +184636,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 +184791,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +184823,6 @@ }, { "$ref": "#/components/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 +184849,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149060,7 +184906,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +185155,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 +185332,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149468,7 +185375,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +185396,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 +185551,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +185583,6 @@ }, { "$ref": "#/components/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 +185609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149648,7 +185666,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +185917,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 +186094,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150058,7 +186137,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +186182,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 +186385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +186417,6 @@ }, { "$ref": "#/components/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 +186443,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150262,7 +186500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +186751,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 +186928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150672,7 +186971,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +186992,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 +187147,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +187179,6 @@ }, { "$ref": "#/components/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 +187205,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150852,7 +187262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +187489,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 +187666,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151238,7 +187709,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +187730,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 +187885,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +187917,6 @@ }, { "$ref": "#/components/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 +187943,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151418,7 +188000,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +188227,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 +188404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151804,7 +188447,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +188468,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 +188623,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +188655,6 @@ }, { "$ref": "#/components/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 +188681,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151984,7 +188738,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +188965,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 +189142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152370,7 +189185,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +189206,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 +189361,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +189393,6 @@ }, { "$ref": "#/components/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 +189419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152550,7 +189476,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +189721,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 +189898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152954,7 +189941,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +189980,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 +190171,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +190203,6 @@ }, { "$ref": "#/components/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 +190229,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153152,7 +190286,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +190549,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 +190726,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153574,7 +190769,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +190808,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 +190999,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +191031,6 @@ }, { "$ref": "#/components/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 +191057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153772,7 +191114,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +191377,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 +191554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154194,7 +191597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +191636,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 +191827,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +191859,6 @@ }, { "$ref": "#/components/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 +191885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154392,7 +191942,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +192205,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 +192382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154814,7 +192425,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +192464,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 +192655,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +192687,6 @@ }, { "$ref": "#/components/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 +192713,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155012,7 +192770,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +193015,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 +193192,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155416,7 +193235,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +193256,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 +193411,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +193443,6 @@ }, { "$ref": "#/components/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 +193469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155596,7 +193526,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +193752,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 +193929,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155981,7 +193972,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +193992,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 +194145,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +194177,6 @@ }, { "$ref": "#/components/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 +194203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156160,7 +194260,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +194499,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 +194676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156558,7 +194719,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +194753,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 +194934,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +194966,6 @@ }, { "$ref": "#/components/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 +194992,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156751,7 +195049,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +195290,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 +195467,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157151,7 +195510,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +195532,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 +195689,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +195721,6 @@ }, { "$ref": "#/components/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 +195747,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157332,7 +195804,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +196033,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 +196210,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157720,7 +196253,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +196275,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 +196432,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +196464,6 @@ }, { "$ref": "#/components/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 +196490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157901,7 +196547,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +196776,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 +196953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158289,7 +196996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +197018,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 +197175,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +197207,6 @@ }, { "$ref": "#/components/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 +197233,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158470,7 +197290,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +197519,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 +197696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158858,7 +197739,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +197761,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 +197918,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +197950,6 @@ }, { "$ref": "#/components/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 +197976,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159039,7 +198033,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +198747,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 +198934,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159922,7 +198977,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +198998,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 +199153,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +199185,6 @@ }, { "$ref": "#/components/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 +199211,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160102,7 +199268,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +200138,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 +200326,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161142,7 +200369,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +200390,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 +200545,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +200577,6 @@ }, { "$ref": "#/components/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 +200603,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161322,7 +200660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +201637,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 +201842,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162486,7 +201885,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +201907,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 +202064,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +202096,6 @@ }, { "$ref": "#/components/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 +202122,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162667,7 +202179,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +202452,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 +202629,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163099,7 +202672,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +202712,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 +202905,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +202937,6 @@ }, { "$ref": "#/components/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 +202963,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163298,7 +203020,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +203266,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 +203443,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163703,7 +203486,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +203507,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 +203662,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +203694,6 @@ }, { "$ref": "#/components/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 +203720,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163883,7 +203777,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +204010,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 +204187,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164275,7 +204230,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +204257,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 +204424,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +204456,6 @@ }, { "$ref": "#/components/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 +204482,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164461,7 +204539,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +204778,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 +204955,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164859,7 +204998,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +205025,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 +205192,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +205224,6 @@ }, { "$ref": "#/components/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 +205250,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165045,7 +205307,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +205642,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 +205827,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165541,7 +205870,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +205891,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 +206046,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +206078,6 @@ }, { "$ref": "#/components/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 +206104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165721,7 +206161,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +206394,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 +206571,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166113,7 +206614,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +206635,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 +206790,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +206822,6 @@ }, { "$ref": "#/components/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 +206848,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166293,7 +206905,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +207138,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 +207315,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166685,7 +207358,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +207385,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 +207552,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +207584,6 @@ }, { "$ref": "#/components/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 +207610,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166871,7 +207667,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +208496,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 +208706,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167897,7 +208749,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +208776,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 +208943,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +208975,6 @@ }, { "$ref": "#/components/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 +209001,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168083,7 +209058,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +209322,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 +209499,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168506,7 +209542,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +209563,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 +209718,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +209750,6 @@ }, { "$ref": "#/components/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 +209776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168686,7 +209833,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +210072,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 +210249,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169084,7 +210292,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +210325,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 +210504,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +210536,6 @@ }, { "$ref": "#/components/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 +210562,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169276,7 +210619,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +210858,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 +211035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169674,7 +211078,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +211099,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 +211254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +211286,6 @@ }, { "$ref": "#/components/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 +211312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169854,7 +211369,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +211596,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 +211773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170240,7 +211816,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +211837,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 +211992,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +212024,6 @@ }, { "$ref": "#/components/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 +212050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170420,7 +212107,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +212337,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 +212514,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170809,7 +212557,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +212581,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 +212742,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +212774,6 @@ }, { "$ref": "#/components/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 +212800,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170992,7 +212857,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +213275,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 +213460,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171572,7 +213503,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +213524,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 +213679,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +213711,6 @@ }, { "$ref": "#/components/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 +213737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171752,7 +213794,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +214115,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": [ + "asOfDate", + "accountIdentifier", + "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 +214304,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172234,7 +214347,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +214368,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 +214523,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +214555,6 @@ }, { "$ref": "#/components/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 +214581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172414,7 +214638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +214954,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": [ + "asOfDate", + "accountIdentifier", + "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 +215143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172891,7 +215186,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +215207,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 +215362,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +215394,6 @@ }, { "$ref": "#/components/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 +215420,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173071,7 +215477,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +215837,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": [ + "asOfDate", + "accountIdentifier", + "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 +216041,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173602,7 +216084,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +216105,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 +216260,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +216292,6 @@ }, { "$ref": "#/components/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 +216318,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173782,7 +216375,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +218146,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 +218366,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175760,7 +218409,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +218432,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 +218591,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +218623,6 @@ }, { "$ref": "#/components/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 +218649,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175942,7 +218706,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +218983,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 +219160,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176378,7 +219203,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +219226,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 +219385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +219417,6 @@ }, { "$ref": "#/components/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 +219443,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176560,7 +219500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +219815,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": [ + "asOfDate", + "accountIdentifier", + "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 +220004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177036,7 +220047,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +220068,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 +220223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +220255,6 @@ }, { "$ref": "#/components/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 +220281,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177216,7 +220338,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +220698,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": [ + "asOfDate", + "accountIdentifier", + "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 +220902,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177747,7 +220945,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +220966,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 +221121,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +221153,6 @@ }, { "$ref": "#/components/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 +221179,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177927,7 +221236,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +221494,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 +221671,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178344,7 +221714,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +221756,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 +221953,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +221985,6 @@ }, { "$ref": "#/components/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 +222011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178545,7 +222068,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +222352,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 +222511,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178970,7 +222554,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +222576,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 +222733,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +222765,6 @@ }, { "$ref": "#/components/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 +222791,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179151,7 +222848,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +223081,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 +223258,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179543,7 +223301,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +223335,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 +223516,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +223548,6 @@ }, { "$ref": "#/components/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 +223574,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179736,7 +223631,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +223885,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 +224062,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180149,7 +224105,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +224140,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 +224323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +224355,6 @@ }, { "$ref": "#/components/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 +224381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180343,7 +224438,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +224682,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 +224859,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180746,7 +224902,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +224926,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 +225087,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +225119,6 @@ }, { "$ref": "#/components/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 +225145,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180929,7 +225202,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +225432,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 +225609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181318,7 +225652,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +225673,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 +225828,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +225860,6 @@ }, { "$ref": "#/components/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 +225886,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181498,7 +225943,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +226170,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 +226347,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181884,7 +226390,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +226411,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 +226566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +226598,6 @@ }, { "$ref": "#/components/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 +226624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182064,7 +226681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +226908,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 +227085,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182450,7 +227128,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +227149,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 +227304,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +227336,6 @@ }, { "$ref": "#/components/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 +227362,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182630,7 +227419,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +227646,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 +227823,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183016,7 +227866,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +227887,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 +228042,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +228074,6 @@ }, { "$ref": "#/components/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 +228100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183196,7 +228157,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +228384,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 +228561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183582,7 +228604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +228625,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 +228780,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +228812,6 @@ }, { "$ref": "#/components/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 +228838,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183762,7 +228895,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +229122,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 +229299,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184148,7 +229342,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +229363,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 +229518,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +229550,6 @@ }, { "$ref": "#/components/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 +229576,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184328,7 +229633,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +229860,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 +230037,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184714,7 +230080,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +230101,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 +230256,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +230288,6 @@ }, { "$ref": "#/components/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 +230314,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184894,7 +230371,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +230659,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 +230809,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185314,7 +230852,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +230873,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 +231028,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +231060,6 @@ }, { "$ref": "#/components/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 +231086,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185494,7 +231143,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +231994,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", + "namespace", + "identificationCode" + ], + "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 +232197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186524,7 +232240,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +232262,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 +232419,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +232451,6 @@ }, { "$ref": "#/components/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 +232477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186705,7 +232534,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +232784,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 +232961,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187114,7 +233004,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +233025,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 +233180,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +233212,6 @@ }, { "$ref": "#/components/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 +233238,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187294,7 +233295,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +233522,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 +233699,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187680,7 +233742,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +233763,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 +233918,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +233950,6 @@ }, { "$ref": "#/components/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 +233976,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187860,7 +234033,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +234260,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 +234437,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188246,7 +234480,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +234501,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 +234656,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +234688,6 @@ }, { "$ref": "#/components/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 +234714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188426,7 +234771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +235067,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": [ + "eventDate", + "openStaffPositionEventTypeDescriptor", + "educationOrganizationId", + "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 +235247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188874,7 +235290,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +235311,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 +235466,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +235498,6 @@ }, { "$ref": "#/components/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 +235524,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189054,7 +235581,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +235805,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 +235982,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189437,7 +236025,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +236046,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 +236201,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +236233,6 @@ }, { "$ref": "#/components/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 +236259,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189617,7 +236316,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +237037,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 +237339,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190622,7 +237382,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +237403,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 +237558,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +237590,6 @@ }, { "$ref": "#/components/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 +237616,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190802,7 +237673,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +238005,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 +238182,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191293,7 +238225,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +238264,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 +238455,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +238487,6 @@ }, { "$ref": "#/components/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 +238513,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191491,7 +238570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +238876,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 +239026,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191929,7 +239069,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +239090,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 +239245,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +239277,6 @@ }, { "$ref": "#/components/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 +239303,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -192109,7 +239360,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +240641,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 +240823,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193559,7 +240866,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +240887,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 +241042,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +241074,6 @@ }, { "$ref": "#/components/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 +241100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193739,7 +241157,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +241426,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 +241603,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194167,7 +241646,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +241689,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 +241888,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +241920,6 @@ }, { "$ref": "#/components/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 +241946,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194369,7 +242003,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +242252,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 +242429,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194777,7 +242472,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +242493,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 +242648,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +242680,6 @@ }, { "$ref": "#/components/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 +242706,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194957,7 +242763,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +242990,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 +243167,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195343,7 +243210,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +243231,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 +243386,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +243418,6 @@ }, { "$ref": "#/components/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 +243444,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195523,7 +243501,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +243728,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 +243905,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195909,7 +243948,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +243969,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 +244124,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +244156,6 @@ }, { "$ref": "#/components/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 +244182,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196089,7 +244239,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +244466,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 +244643,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196475,7 +244686,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +244707,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 +244862,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +244894,6 @@ }, { "$ref": "#/components/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 +244920,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196655,7 +244977,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +245229,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 +245391,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197050,7 +245434,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +245455,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 +245610,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +245642,6 @@ }, { "$ref": "#/components/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 +245668,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197230,7 +245725,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +245939,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 +246116,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197603,7 +246159,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +246180,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 +246335,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +246367,6 @@ }, { "$ref": "#/components/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 +246393,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197783,7 +246450,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +246811,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": [ + "pathPhaseName", + "educationOrganizationId", + "pathName" + ], + "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 +246989,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198297,7 +247032,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +247053,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 +247208,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +247240,6 @@ }, { "$ref": "#/components/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 +247266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198477,7 +247323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +247609,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 +247772,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198907,7 +247815,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +247836,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 +247991,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +248023,6 @@ }, { "$ref": "#/components/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 +248049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199087,7 +248106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +248309,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 +248450,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199413,7 +248493,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +248515,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 +248672,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +248704,6 @@ }, { "$ref": "#/components/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 +248730,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199594,7 +248787,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +248991,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 +249168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199957,7 +249211,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +249233,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 +249390,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +249422,6 @@ }, { "$ref": "#/components/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 +249448,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200138,7 +249505,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +249733,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 +249910,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200525,7 +249953,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +249974,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 +250129,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +250161,6 @@ }, { "$ref": "#/components/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 +250187,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200705,7 +250244,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +251033,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", + "schoolYear", + "termDescriptor", + "personId", + "sourceSystemDescriptor" + ], + "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 +251337,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201749,7 +251380,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +251401,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 +251556,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +251588,6 @@ }, { "$ref": "#/components/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 +251614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201929,7 +251671,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +251969,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 +252146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202386,7 +252189,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +252210,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 +252365,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +252397,6 @@ }, { "$ref": "#/components/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 +252423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202566,7 +252480,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +253042,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 +253263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203310,7 +253306,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +253327,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 +253482,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +253514,6 @@ }, { "$ref": "#/components/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 +253540,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203490,7 +253597,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +253850,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 +254027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203902,7 +254070,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +254095,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 +254258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +254290,6 @@ }, { "$ref": "#/components/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 +254316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204086,7 +254373,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +254628,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 +254805,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204500,7 +254848,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +254893,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 +255096,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +255128,6 @@ }, { "$ref": "#/components/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 +255154,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204704,7 +255211,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +255465,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 +255642,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205117,7 +255685,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +255709,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 +255870,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +255902,6 @@ }, { "$ref": "#/components/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 +255928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205300,7 +255985,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +256229,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 +256406,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205703,7 +256449,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +256484,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 +256667,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +256699,6 @@ }, { "$ref": "#/components/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 +256725,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205897,7 +256782,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +257023,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 +257200,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206297,7 +257243,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +257264,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 +257419,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +257451,6 @@ }, { "$ref": "#/components/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 +257477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206477,7 +257534,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +257823,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 +257989,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206909,7 +258032,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +258053,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 +258208,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +258240,6 @@ }, { "$ref": "#/components/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 +258266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207089,7 +258323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +258539,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 +258716,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207464,7 +258759,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +258781,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 +258938,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +258970,6 @@ }, { "$ref": "#/components/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 +258996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207645,7 +259053,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +260418,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 +260608,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209187,7 +260651,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +260673,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 +260830,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +260862,6 @@ }, { "$ref": "#/components/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 +260888,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209368,7 +260945,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +261198,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 +261375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209780,7 +261418,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +261439,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 +261594,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +261626,6 @@ }, { "$ref": "#/components/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 +261652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209960,7 +261709,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +261936,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 +262113,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210346,7 +262156,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +262177,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 +262332,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +262364,6 @@ }, { "$ref": "#/components/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 +262390,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210526,7 +262447,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +262675,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 +262852,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210913,7 +262895,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +262917,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 +263074,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +263106,6 @@ }, { "$ref": "#/components/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 +263132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211094,7 +263189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +263418,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 +263595,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211482,7 +263638,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +263660,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 +263817,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +263849,6 @@ }, { "$ref": "#/components/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 +263875,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211663,7 +263932,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +264161,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 +264338,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212051,7 +264381,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +264403,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 +264560,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +264592,6 @@ }, { "$ref": "#/components/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 +264618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212232,7 +264675,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +265027,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", + "personId", + "sourceSystemDescriptor", + "namespace", + "professionalDevelopmentTitle" + ], + "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 +265235,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212757,7 +265278,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +265299,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 +265454,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +265486,6 @@ }, { "$ref": "#/components/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 +265512,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212937,7 +265569,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +265885,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 +266074,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213422,7 +266117,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +266138,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 +266293,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +266325,6 @@ }, { "$ref": "#/components/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 +266351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213602,7 +266408,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +266641,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 +266818,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213994,7 +266861,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +266882,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 +267037,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +267069,6 @@ }, { "$ref": "#/components/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 +267095,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214174,7 +267152,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +267379,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 +267556,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214560,7 +267599,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +267620,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 +267775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +267807,6 @@ }, { "$ref": "#/components/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 +267833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214740,7 +267890,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +268119,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 +268296,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215128,7 +268339,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +268362,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 +268521,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +268553,6 @@ }, { "$ref": "#/components/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 +268579,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215310,7 +268636,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +268876,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 +269053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215709,7 +269096,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +269128,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 +269305,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +269337,6 @@ }, { "$ref": "#/components/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 +269363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215900,7 +269420,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +269719,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 +269869,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216331,7 +269912,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +269933,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 +270088,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +270120,6 @@ }, { "$ref": "#/components/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 +270146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216511,7 +270203,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +270817,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": [ + "programEvaluationElementTitle", + "programEducationOrganizationId", + "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 +271079,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217344,7 +271122,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +271144,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 +271301,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +271333,6 @@ }, { "$ref": "#/components/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 +271359,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217525,7 +271416,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +271969,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": [ + "programEvaluationObjectiveTitle", + "programEducationOrganizationId", + "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 +272221,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218287,7 +272264,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +272286,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 +272443,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +272475,6 @@ }, { "$ref": "#/components/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 +272501,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218468,7 +272558,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +272827,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 +273004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218896,7 +273047,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +273069,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 +273226,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +273258,6 @@ }, { "$ref": "#/components/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 +273284,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219077,7 +273341,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +273570,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 +273747,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219465,7 +273790,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +273812,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 +273969,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +274001,6 @@ }, { "$ref": "#/components/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 +274027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219646,7 +274084,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +274576,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": [ + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programEducationOrganizationId", + "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 +274804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220328,7 +274847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +274869,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 +275026,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +275058,6 @@ }, { "$ref": "#/components/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 +275084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220509,7 +275141,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +275407,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 +275584,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220934,7 +275627,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +275659,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 +275836,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +275868,6 @@ }, { "$ref": "#/components/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 +275894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221125,7 +275951,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +276201,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 +276378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221534,7 +276421,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +276454,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 +276633,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +276665,6 @@ }, { "$ref": "#/components/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 +276691,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221726,7 +276748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +277217,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 +277382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222337,7 +277425,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +277457,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 +277634,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +277666,6 @@ }, { "$ref": "#/components/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 +277692,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222528,7 +277749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +277984,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 +278161,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222922,7 +278204,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +278225,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 +278380,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +278412,6 @@ }, { "$ref": "#/components/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 +278438,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223102,7 +278495,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +278722,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 +278899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223488,7 +278942,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +278963,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 +279118,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +279150,6 @@ }, { "$ref": "#/components/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 +279176,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223668,7 +279233,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +279521,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 +279671,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224088,7 +279714,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +279735,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 +279890,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +279922,6 @@ }, { "$ref": "#/components/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 +279948,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224268,7 +280005,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +280213,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 +280390,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224635,7 +280433,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +280454,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 +280609,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +280641,6 @@ }, { "$ref": "#/components/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 +280667,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224815,7 +280724,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +280951,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 +281128,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225201,7 +281171,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +281192,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 +281347,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +281379,6 @@ }, { "$ref": "#/components/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 +281405,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225381,7 +281462,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +281689,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 +281866,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225767,7 +281909,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +281930,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 +282085,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +282117,6 @@ }, { "$ref": "#/components/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 +282143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225947,7 +282200,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +282434,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 +282611,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226340,7 +282654,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +282682,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 +282851,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +282883,6 @@ }, { "$ref": "#/components/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 +282909,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226527,7 +282966,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +283200,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 +283377,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226920,7 +283420,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +283441,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 +283596,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +283628,6 @@ }, { "$ref": "#/components/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 +283654,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227100,7 +283711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +284421,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", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor", + "evaluationElementTitle", + "quantitativeMeasureIdentifier" + ], + "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 +284755,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228066,7 +284798,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +284819,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 +284974,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +285006,6 @@ }, { "$ref": "#/components/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 +285032,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228246,7 +285089,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +285377,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 +285554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228693,7 +285597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +285618,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 +285773,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +285805,6 @@ }, { "$ref": "#/components/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 +285831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228873,7 +285888,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +286325,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", + "schoolYear", + "termDescriptor", + "quantitativeMeasureIdentifier" + ], + "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 +286614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229536,7 +286657,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +286678,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 +286833,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +286865,6 @@ }, { "$ref": "#/components/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 +286891,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229716,7 +286948,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287214,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 +287391,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230141,7 +287434,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +287455,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 +287610,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287642,6 @@ }, { "$ref": "#/components/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 +287668,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230321,7 +287725,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +287957,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 +288134,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230712,7 +288177,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +288203,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 +288368,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288400,6 @@ }, { "$ref": "#/components/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 +288426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230897,7 +288483,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +288716,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 +288893,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231289,7 +288936,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +288958,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 +289115,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289147,6 @@ }, { "$ref": "#/components/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 +289173,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231470,7 +289230,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289460,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 +289637,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231859,7 +289680,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +289703,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 +289862,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +289894,6 @@ }, { "$ref": "#/components/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 +289920,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232041,7 +289977,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +290207,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 +290384,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232430,7 +290427,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +290449,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 +290606,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +290638,6 @@ }, { "$ref": "#/components/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 +290664,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232611,7 +290721,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +290962,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 +291139,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233011,7 +291182,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +291216,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 +291397,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +291429,6 @@ }, { "$ref": "#/components/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 +291455,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233204,7 +291512,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293052,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": [ + "recruitmentEventAttendeeIdentifier", + "educationOrganizationId", + "eventDate", + "eventTitle" + ], + "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 +293415,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235078,7 +293458,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +293479,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 +293634,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +293666,6 @@ }, { "$ref": "#/components/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 +293692,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235258,7 +293749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294101,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 +294278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235769,7 +294321,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +294342,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 +294497,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294529,6 @@ }, { "$ref": "#/components/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 +294555,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235949,7 +294612,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +294839,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 +295016,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236335,7 +295059,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +295080,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 +295235,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295267,6 @@ }, { "$ref": "#/components/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 +295293,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236515,7 +295350,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +295661,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 +295844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236986,7 +295887,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +295908,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 +296063,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296095,6 @@ }, { "$ref": "#/components/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 +296121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237166,7 +296178,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296408,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 +296585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237555,7 +296628,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +296649,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 +296804,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +296836,6 @@ }, { "$ref": "#/components/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 +296862,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237735,7 +296919,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297154,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 +297331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238129,7 +297374,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +297403,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 +297574,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +297606,6 @@ }, { "$ref": "#/components/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 +297632,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238317,7 +297689,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +298603,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 +298831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239421,7 +298874,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +298896,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 +299053,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299085,6 @@ }, { "$ref": "#/components/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 +299111,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239602,7 +299168,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299423,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 +299600,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240016,7 +299643,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +299664,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 +299819,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +299851,6 @@ }, { "$ref": "#/components/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 +299877,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240196,7 +299934,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300161,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 +300338,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240582,7 +300381,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +300402,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 +300557,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300589,6 @@ }, { "$ref": "#/components/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 +300615,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240762,7 +300672,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +300903,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 +301080,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241152,7 +301123,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +301148,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 +301311,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301343,6 @@ }, { "$ref": "#/components/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 +301369,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241336,7 +301426,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +301658,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 +301835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241727,7 +301878,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +301900,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 +302057,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302089,6 @@ }, { "$ref": "#/components/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 +302115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241908,7 +302172,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302400,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 +302577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242295,7 +302620,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +302641,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 +302796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +302828,6 @@ }, { "$ref": "#/components/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 +302854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242475,7 +302911,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303138,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 +303315,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242861,7 +303358,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +303379,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 +303534,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +303566,6 @@ }, { "$ref": "#/components/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 +303592,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243041,7 +303649,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304149,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 +304333,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243702,7 +304376,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +304397,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 +304552,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304584,6 @@ }, { "$ref": "#/components/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 +304610,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243882,7 +304667,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +304909,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 +305086,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244283,7 +305129,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +305156,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 +305323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305355,6 @@ }, { "$ref": "#/components/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 +305381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244469,7 +305438,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +305672,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 +305849,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244862,7 +305892,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +305914,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 +306071,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +306103,6 @@ }, { "$ref": "#/components/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 +306129,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245043,7 +306186,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +306639,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", + "schoolYear", + "termDescriptor", + "rubricRating" + ], + "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 +306935,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245730,7 +306978,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +306999,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 +307154,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307186,6 @@ }, { "$ref": "#/components/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 +307212,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245910,7 +307269,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307541,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 +307718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246341,7 +307761,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +307782,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 +307937,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +307969,6 @@ }, { "$ref": "#/components/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 +307995,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246521,7 +308052,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308279,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 +308456,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246907,7 +308499,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +308520,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 +308675,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +308707,6 @@ }, { "$ref": "#/components/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 +308733,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247087,7 +308790,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309030,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 +309207,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247486,7 +309250,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +309284,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 +309465,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309497,6 @@ }, { "$ref": "#/components/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 +309523,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247679,7 +309580,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +309824,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 +310001,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248082,7 +310044,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +310069,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 +310232,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310264,6 @@ }, { "$ref": "#/components/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 +310290,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248266,7 +310347,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +310580,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 +310757,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248658,7 +310800,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +310823,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 +310982,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +311014,6 @@ }, { "$ref": "#/components/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 +311040,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248840,7 +311097,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +311326,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 +311503,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249228,7 +311546,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +311567,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 +311722,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +311754,6 @@ }, { "$ref": "#/components/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 +311780,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249408,7 +311837,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312077,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 +312254,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249807,7 +312297,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +312331,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 +312512,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312544,6 @@ }, { "$ref": "#/components/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 +312570,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250000,7 +312627,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +312835,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 +312976,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250336,7 +313019,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +313039,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 +313192,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +313224,6 @@ }, { "$ref": "#/components/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 +313250,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250515,7 +313307,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +314966,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 +315247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252442,7 +315290,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +315324,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 +315505,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +315537,6 @@ }, { "$ref": "#/components/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 +315563,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252635,7 +315620,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +315947,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 +316124,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253121,7 +316167,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +316188,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 +316343,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +316375,6 @@ }, { "$ref": "#/components/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 +316401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253301,7 +316458,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +316889,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 +317124,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253924,7 +317167,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +317188,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 +317343,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +317375,6 @@ }, { "$ref": "#/components/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 +317401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254104,7 +317458,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +317722,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 +317899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254527,7 +317942,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +317975,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 +318154,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +318186,6 @@ }, { "$ref": "#/components/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 +318212,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254719,7 +318269,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +318520,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 +318697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255129,7 +318740,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +318773,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 +318952,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +318984,6 @@ }, { "$ref": "#/components/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 +319010,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255321,7 +319067,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +320026,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", + "sessionName", + "sectionIdentifier" + ], + "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 +320330,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256551,7 +320373,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +320406,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 +320585,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +320617,6 @@ }, { "$ref": "#/components/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 +320643,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256743,7 +320700,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +321022,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 +321199,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257224,7 +321242,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +321263,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 +321418,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +321450,6 @@ }, { "$ref": "#/components/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 +321476,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257404,7 +321533,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +321760,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 +321937,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257790,7 +321980,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +322001,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 +322156,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +322188,6 @@ }, { "$ref": "#/components/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 +322214,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257970,7 +322271,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +322498,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 +322675,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258356,7 +322718,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +322739,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 +322894,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +322926,6 @@ }, { "$ref": "#/components/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 +322952,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258536,7 +323009,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +323242,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 +323419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258928,7 +323462,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +323489,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 +323656,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +323688,6 @@ }, { "$ref": "#/components/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 +323714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259114,7 +323771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +324004,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 +324181,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259506,7 +324224,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +324245,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 +324400,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +324432,6 @@ }, { "$ref": "#/components/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 +324458,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259686,7 +324515,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +324742,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 +324919,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260072,7 +324962,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +324983,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 +325138,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +325170,6 @@ }, { "$ref": "#/components/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 +325196,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260252,7 +325253,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +325480,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 +325657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260638,7 +325700,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +325721,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 +325876,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +325908,6 @@ }, { "$ref": "#/components/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 +325934,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260818,7 +325991,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +326540,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 +326732,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261536,7 +326775,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +326803,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 +326972,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +327004,6 @@ }, { "$ref": "#/components/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 +327030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261723,7 +327087,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +327354,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 +327531,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262149,7 +327574,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +327618,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 +327819,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +327851,6 @@ }, { "$ref": "#/components/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 +327877,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262352,7 +327934,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +328245,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 +328395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262795,7 +328438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +328459,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 +328614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +328646,6 @@ }, { "$ref": "#/components/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 +328672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262975,7 +328729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +328938,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 +329115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -263343,7 +329158,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +329180,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 +329337,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +329369,6 @@ }, { "$ref": "#/components/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 +329395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -263524,7 +329452,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +329681,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 +329858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -263912,7 +329901,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +329923,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 +330080,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +330112,6 @@ }, { "$ref": "#/components/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 +330138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264093,7 +330195,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +330424,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 +330601,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264481,7 +330644,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +330666,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 +330823,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +330855,6 @@ }, { "$ref": "#/components/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 +330881,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264662,7 +330938,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +331168,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 +331345,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265051,7 +331388,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +331411,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 +331570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +331602,6 @@ }, { "$ref": "#/components/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 +331628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265233,7 +331685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +331983,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 +332157,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265682,7 +332200,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +332221,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 +332376,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +332408,6 @@ }, { "$ref": "#/components/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 +332434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265862,7 +332491,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +332712,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 +332889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266242,7 +332932,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +332953,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 +333108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +333140,6 @@ }, { "$ref": "#/components/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 +333166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266422,7 +333223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +333547,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 +333735,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266906,7 +333778,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +333799,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 +333954,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +333986,6 @@ }, { "$ref": "#/components/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 +334012,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -267086,7 +334069,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +334871,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 +335059,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -268058,7 +335102,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +335123,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 +335278,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +335310,6 @@ }, { "$ref": "#/components/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 +335336,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -268238,7 +335393,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +336544,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 +336685,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269512,7 +336728,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +336749,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 +336904,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +336936,6 @@ }, { "$ref": "#/components/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 +336962,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269692,7 +337019,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +337315,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 +337471,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -270121,7 +337514,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +337535,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 +337690,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +337722,6 @@ }, { "$ref": "#/components/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 +337748,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -270301,7 +337805,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +338311,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 +338577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -271045,7 +338620,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +338641,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 +338796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +338828,6 @@ }, { "$ref": "#/components/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 +338854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -271225,7 +338911,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +339883,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 +340180,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272466,7 +340223,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +340244,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 +340399,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +340431,6 @@ }, { "$ref": "#/components/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 +340457,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272646,7 +340514,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +340926,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 +341125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -273228,7 +341168,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +341189,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 +341344,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +341376,6 @@ }, { "$ref": "#/components/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 +341402,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -273408,7 +341459,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +341777,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 +341951,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -273877,7 +341994,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +342015,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 +342170,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +342202,6 @@ }, { "$ref": "#/components/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 +342228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274057,7 +342285,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +342510,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 +342687,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274441,7 +342730,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +342751,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 +342906,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +342938,6 @@ }, { "$ref": "#/components/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 +342964,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274621,7 +343021,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +343248,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 +343425,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -275007,7 +343468,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +343489,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 +343644,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +343676,6 @@ }, { "$ref": "#/components/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 +343702,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -275187,7 +343759,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +344068,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 +344250,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -275655,7 +344293,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +344314,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 +344469,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +344501,6 @@ }, { "$ref": "#/components/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 +344527,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -275835,7 +344584,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +344930,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 +345133,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -276351,7 +345176,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +345200,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 +345361,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +345393,6 @@ }, { "$ref": "#/components/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 +345419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -276534,7 +345476,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +345974,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 +346149,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277184,7 +346192,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +346215,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 +346374,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +346406,6 @@ }, { "$ref": "#/components/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 +346432,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277366,7 +346489,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +346941,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 +347200,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278034,7 +347243,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +347267,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 +347428,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +347460,6 @@ }, { "$ref": "#/components/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 +347486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278217,7 +347543,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +347813,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 +347990,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278646,7 +348033,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +348054,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 +348209,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +348241,6 @@ }, { "$ref": "#/components/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 +348267,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278826,7 +348324,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +349770,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 +350061,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -280550,7 +350104,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +350135,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 +350310,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +350342,6 @@ }, { "$ref": "#/components/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 +350368,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -280740,7 +350425,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +350775,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 +350952,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -281249,7 +350995,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +351043,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 +351252,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +351284,6 @@ }, { "$ref": "#/components/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 +351310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -281456,7 +351367,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +352823,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 +352995,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283071,7 +353038,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +353060,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 +353217,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +353249,6 @@ }, { "$ref": "#/components/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 +353275,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283252,7 +353332,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +355188,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 +355476,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -285368,7 +355519,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +355544,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 +355707,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +355739,6 @@ }, { "$ref": "#/components/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 +355765,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -285552,7 +355822,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +356263,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": [ + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "assessmentIdentifier", + "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 +356475,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286166,7 +356518,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +356539,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 +356694,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +356726,6 @@ }, { "$ref": "#/components/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 +356752,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286346,7 +356809,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +357251,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": [ + "assessmentBatteryPartName", + "administrationIdentifier", + "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 +357469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286962,7 +357512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +357533,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 +357688,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +357720,6 @@ }, { "$ref": "#/components/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 +357746,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -287142,7 +357803,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +358483,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", + "namespace", + "educationOrganizationId", + "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 +358764,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -288064,7 +358807,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +358828,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 +358983,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +359015,6 @@ }, { "$ref": "#/components/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 +359041,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -288244,7 +359098,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +360766,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 +361084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290201,7 +361127,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +361149,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 +361306,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +361338,6 @@ }, { "$ref": "#/components/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 +361364,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290382,7 +361421,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +362224,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 +362476,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -291399,7 +362519,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +362540,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 +362695,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +362727,6 @@ }, { "$ref": "#/components/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 +362753,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -291579,7 +362810,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +363088,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 +363265,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292016,7 +363308,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +363332,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 +363493,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +363525,6 @@ }, { "$ref": "#/components/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 +363551,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292199,7 +363608,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +364031,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 +364211,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292774,7 +364254,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +364276,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 +364433,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +364465,6 @@ }, { "$ref": "#/components/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 +364491,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292955,7 +364548,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +365221,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", + "objectiveEducationOrganizationId", + "objective", + "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 +365470,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -293829,7 +365513,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +365535,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 +365692,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +365724,6 @@ }, { "$ref": "#/components/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 +365750,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294010,7 +365807,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +366204,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 +366404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294589,7 +366447,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +366468,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 +366623,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +366655,6 @@ }, { "$ref": "#/components/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 +366681,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294769,7 +366738,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +367939,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 +368154,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296167,7 +368197,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +368220,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 +368379,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +368411,6 @@ }, { "$ref": "#/components/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 +368437,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296349,7 +368494,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +369666,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 +369807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297644,7 +369850,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +369872,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 +370029,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +370061,6 @@ }, { "$ref": "#/components/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 +370087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297825,7 +370144,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +370531,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 +370723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298376,7 +370766,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +370787,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 +370942,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +370974,6 @@ }, { "$ref": "#/components/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 +371000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298556,7 +371057,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +371369,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 +371525,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -299001,7 +371568,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +371589,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 +371744,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +371776,6 @@ }, { "$ref": "#/components/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 +371802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -299181,7 +371859,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +372139,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 +372280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -299584,7 +372323,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +372344,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 +372499,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +372531,6 @@ }, { "$ref": "#/components/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 +372557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -299764,7 +372614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +373455,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 +373676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -300808,7 +373719,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +373741,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 +373898,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +373930,6 @@ }, { "$ref": "#/components/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 +373956,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -300989,7 +374013,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +374401,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 +374591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -301539,7 +374634,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +374655,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 +374810,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +374842,6 @@ }, { "$ref": "#/components/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 +374868,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -301719,7 +374925,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +375414,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 +375669,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -302439,7 +375712,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +375734,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 +375891,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +375923,6 @@ }, { "$ref": "#/components/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 +375949,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -302620,7 +376006,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +376599,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 +376767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -303363,7 +376810,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +376831,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 +376986,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +377018,6 @@ }, { "$ref": "#/components/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 +377044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -303543,7 +377101,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +377791,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 +378043,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304447,7 +378086,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +378107,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 +378262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +378294,6 @@ }, { "$ref": "#/components/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 +378320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304627,7 +378377,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +378915,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": [ + "iepGoalIdentifier", + "educationOrganizationId", + "iepFinalizedDate", + "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 +379119,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -305336,7 +379162,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +379183,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 +379338,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +379370,6 @@ }, { "$ref": "#/components/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 +379396,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -305516,7 +379453,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +380209,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": [ + "iepServiceDeliveryIdentifier", + "serviceDeliveryDate", + "serviceDeliveryDescriptor", + "educationOrganizationId", + "iepFinalizedDate", + "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 +380445,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306465,7 +380488,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +380509,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 +380664,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +380696,6 @@ }, { "$ref": "#/components/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 +380722,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306645,7 +380779,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +381436,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": [ + "servicePrescriptionDate", + "servicePrescriptionDescriptor", + "educationOrganizationId", + "iepFinalizedDate", + "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 +381700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -307528,7 +381743,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +381764,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 +381919,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +381951,6 @@ }, { "$ref": "#/components/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 +381977,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -307708,7 +382034,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +382912,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 +383171,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -308817,7 +383214,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +383235,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 +383390,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +383422,6 @@ }, { "$ref": "#/components/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 +383448,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -308997,7 +383505,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +383866,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 +384040,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -309509,7 +384083,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +384105,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 +384262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +384294,6 @@ }, { "$ref": "#/components/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 +384320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -309690,7 +384377,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +384604,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 +384781,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310076,7 +384824,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +384846,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 +385003,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +385035,6 @@ }, { "$ref": "#/components/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 +385061,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310257,7 +385118,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +385604,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 +385798,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310914,7 +385841,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +385863,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 +386020,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +386052,6 @@ }, { "$ref": "#/components/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 +386078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311095,7 +386135,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +386555,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", + "eventDate", + "educationOrganizationId", + "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 +386777,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311704,7 +386820,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +386841,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 +386996,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +387028,6 @@ }, { "$ref": "#/components/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 +387054,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311884,7 +387111,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +387953,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 +388197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -312932,7 +388240,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +388261,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 +388416,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +388448,6 @@ }, { "$ref": "#/components/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 +388474,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -313112,7 +388531,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +389377,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 +389684,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -314227,7 +389727,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +389748,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 +389903,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +389935,6 @@ }, { "$ref": "#/components/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 +389961,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -314407,7 +390018,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +390796,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 +391050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -315401,7 +391093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +391114,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 +391269,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +391301,6 @@ }, { "$ref": "#/components/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 +391327,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -315581,7 +391384,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +391898,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": [ + "pathMilestoneName", + "pathMilestoneTypeDescriptor", + "educationOrganizationId", + "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 +392107,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -316269,7 +392150,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +392171,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 +392326,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +392358,6 @@ }, { "$ref": "#/components/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 +392384,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -316449,7 +392441,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +392934,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": [ + "pathName", + "pathPhaseName", + "educationOrganizationId", + "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 +393117,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317095,7 +393160,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +393181,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 +393336,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +393368,6 @@ }, { "$ref": "#/components/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 +393394,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317275,7 +393451,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +393786,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 +393944,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317744,7 +393987,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +394008,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 +394163,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +394195,6 @@ }, { "$ref": "#/components/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 +394221,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317924,7 +394278,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +394901,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 +395128,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -318736,7 +395171,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +395198,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 +395365,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +395397,6 @@ }, { "$ref": "#/components/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 +395423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -318922,7 +395480,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +395985,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 +396237,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -319636,7 +396280,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +396303,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 +396462,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +396494,6 @@ }, { "$ref": "#/components/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 +396520,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -319818,7 +396577,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +397609,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 +397896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -321089,7 +397939,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +397961,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 +398118,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +398150,6 @@ }, { "$ref": "#/components/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 +398176,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -321270,7 +398233,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +399248,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 +399610,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322624,7 +399653,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +399678,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 +399841,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +399873,6 @@ }, { "$ref": "#/components/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 +399899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322808,7 +399956,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +400598,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 +400851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323665,7 +400894,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +400917,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 +401076,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +401108,6 @@ }, { "$ref": "#/components/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 +401134,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323847,7 +401191,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +401885,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 +402120,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324738,7 +402163,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +402184,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 +402339,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +402371,6 @@ }, { "$ref": "#/components/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 +402397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324918,7 +402454,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +403105,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 +403375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -325801,7 +403418,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +403439,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 +403594,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +403626,6 @@ }, { "$ref": "#/components/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 +403652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -325981,7 +403709,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +404416,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 +404719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -326948,7 +404762,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +404791,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 +404962,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +404994,6 @@ }, { "$ref": "#/components/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 +405020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -327136,7 +405077,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +405745,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 +406028,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328039,7 +406071,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +406094,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 +406253,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +406285,6 @@ }, { "$ref": "#/components/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 +406311,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328221,7 +406368,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +407712,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 +408088,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -329903,7 +408131,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +408153,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 +408310,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +408342,6 @@ }, { "$ref": "#/components/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 +408368,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -330084,7 +408425,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +409199,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 +409533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -331154,7 +409576,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +409597,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 +409752,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +409784,6 @@ }, { "$ref": "#/components/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 +409810,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -331334,7 +409867,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +410619,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 +410855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332284,7 +410898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +410919,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 +411074,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +411106,6 @@ }, { "$ref": "#/components/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 +411132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332464,7 +411189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +411689,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 +411882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333139,7 +411925,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +411946,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 +412101,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +412133,6 @@ }, { "$ref": "#/components/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 +412159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333319,7 +412216,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +413085,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 +413375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334465,7 +413418,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +413458,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 +413651,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +413683,6 @@ }, { "$ref": "#/components/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 +413709,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334664,7 +413766,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +414099,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 +414276,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335156,7 +414319,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +414341,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 +414498,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +414530,6 @@ }, { "$ref": "#/components/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 +414556,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335337,7 +414613,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +414843,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 +415020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335726,7 +415063,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +415086,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 +415245,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +415277,6 @@ }, { "$ref": "#/components/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 +415303,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335908,7 +415360,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +415589,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 +415766,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336296,7 +415809,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +415830,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 +415985,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +416017,6 @@ }, { "$ref": "#/components/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 +416043,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336476,7 +416100,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +416381,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 +416554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336901,7 +416597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +416618,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 +416773,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +416805,6 @@ }, { "$ref": "#/components/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 +416831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337081,7 +416888,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +417107,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 +417284,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337459,7 +417327,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +417348,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 +417503,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +417535,6 @@ }, { "$ref": "#/components/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 +417561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337639,7 +417618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +417918,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", + "programName", + "programTypeDescriptor", + "namespace", + "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 +418106,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338093,7 +418149,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +418170,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 +418325,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +418357,6 @@ }, { "$ref": "#/components/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 +418383,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338273,7 +418440,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +419032,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 +419222,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339026,7 +419265,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +419286,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 +419441,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +419473,6 @@ }, { "$ref": "#/components/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 +419499,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339206,7 +419556,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +420102,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": [ + "questionCode", + "namespace", + "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 +420288,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339914,7 +420331,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +420352,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 +420507,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +420539,6 @@ }, { "$ref": "#/components/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 +420565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340094,7 +420622,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +420904,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 +421077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340520,7 +421120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +421141,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 +421296,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +421328,6 @@ }, { "$ref": "#/components/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 +421354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340700,7 +421411,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +421703,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": [ + "personId", + "sourceSystemDescriptor", + "namespace", + "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 +421891,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341146,7 +421934,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +421955,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 +422110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +422142,6 @@ }, { "$ref": "#/components/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 +422168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341326,7 +422225,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +422500,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": [ + "staffUniqueId", + "namespace", + "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 +422673,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341745,7 +422716,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +422737,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 +422892,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +422924,6 @@ }, { "$ref": "#/components/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 +422950,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341925,7 +423007,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +423527,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 +423781,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342675,7 +423824,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +423845,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 +424000,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +424032,6 @@ }, { "$ref": "#/components/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 +424058,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342855,7 +424115,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +424729,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", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor", + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ], + "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 +425084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343736,7 +425127,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +425148,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 +425303,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +425335,6 @@ }, { "$ref": "#/components/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 +425361,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343916,7 +425418,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +425826,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", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "namespace", + "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 +426044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344498,7 +426087,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +426108,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 +426263,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +426295,6 @@ }, { "$ref": "#/components/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 +426321,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344678,7 +426378,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +426699,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 +426887,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345153,7 +426930,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +426951,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 +427106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +427138,6 @@ }, { "$ref": "#/components/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 +427164,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345333,7 +427221,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +427549,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": [ + "personId", + "sourceSystemDescriptor", + "namespace", + "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 +427752,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345825,7 +427795,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +427816,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 +427971,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +428003,6 @@ }, { "$ref": "#/components/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 +428029,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -346005,7 +428086,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +428397,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": [ + "staffUniqueId", + "namespace", + "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 +428585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -346470,7 +428628,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +428649,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 +428804,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +428836,6 @@ }, { "$ref": "#/components/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 +428862,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -346650,7 +428919,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +429253,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": [ + "surveyResponseIdentifier", + "namespace", + "surveyIdentifier", + "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 +429435,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -347137,7 +429478,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +429499,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 +429654,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +429686,6 @@ }, { "$ref": "#/components/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 +429712,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -347317,7 +429769,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +430142,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 +430394,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -347918,7 +430437,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +430458,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 +430613,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +430645,6 @@ }, { "$ref": "#/components/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 +430671,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -348098,7 +430728,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +431169,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 +431378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -348729,7 +431421,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +431442,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 +431597,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +431629,6 @@ }, { "$ref": "#/components/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 +431655,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -348909,7 +431712,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +431958,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 +432135,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -349314,7 +432178,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +432200,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 +432357,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +432389,6 @@ }, { "$ref": "#/components/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 +432415,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -349495,7 +432472,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +432701,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 +432878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -349883,7 +432921,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +432943,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 +433100,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +433132,6 @@ }, { "$ref": "#/components/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 +433158,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -350064,7 +433215,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +433443,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 +433620,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -350451,7 +433663,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +433684,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 +433839,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +433871,6 @@ }, { "$ref": "#/components/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 +433897,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -350631,7 +433954,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +434186,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 +434363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -351022,7 +434406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +434432,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 +434597,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +434629,6 @@ }, { "$ref": "#/components/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 +434655,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -351207,7 +434712,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +434959,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 +435136,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -351613,7 +435179,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +435215,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 +435400,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +435432,6 @@ }, { "$ref": "#/components/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 +435458,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -351808,7 +435515,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +435757,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 +435934,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -352209,7 +435977,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +435998,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 +436153,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +436185,6 @@ }, { "$ref": "#/components/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 +436211,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -352389,7 +436268,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +436495,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 +436672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -352775,7 +436715,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +436736,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 +436891,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +436923,6 @@ }, { "$ref": "#/components/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 +436949,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -352955,7 +437006,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +437246,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 +437423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -353354,7 +437466,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +437500,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 +437681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +437713,6 @@ }, { "$ref": "#/components/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 +437739,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -353547,7 +437796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +438036,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 +438213,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -353946,7 +438256,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +438277,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 +438432,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +438464,6 @@ }, { "$ref": "#/components/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 +438490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -354126,7 +438547,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +438774,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 +438951,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -354512,7 +438994,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +439015,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 +439170,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +439202,6 @@ }, { "$ref": "#/components/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 +439228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -354692,7 +439285,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +439512,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 +439689,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -355078,7 +439732,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +439753,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 +439908,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +439940,6 @@ }, { "$ref": "#/components/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 +439966,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -355258,7 +440023,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +440250,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 +440427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -355644,7 +440470,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +440491,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 +440646,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +440678,6 @@ }, { "$ref": "#/components/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 +440704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -355824,7 +440761,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +440991,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 +441168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -356213,7 +441211,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +441235,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 +441396,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +441428,6 @@ }, { "$ref": "#/components/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 +441454,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -356396,7 +441511,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +441746,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 +441923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -356790,7 +441966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +441992,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 +442157,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +442189,6 @@ }, { "$ref": "#/components/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 +442215,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -356975,7 +442272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +442504,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 +442681,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -357366,7 +442724,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +442745,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 +442900,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +442932,6 @@ }, { "$ref": "#/components/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 +442958,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -357546,7 +443015,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +443242,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 +443419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -357932,7 +443462,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. 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 +443483,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 +443638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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 +443670,6 @@ }, { "$ref": "#/components/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 +443696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -358112,7 +443753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. 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..021f3ccb9 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": [ + "evaluationElementTitle", + "educationOrganizationId", + "evaluationDate", + "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": [ + "evaluationElementTitle", + "educationOrganizationId", + "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": [ + "evaluationObjectiveTitle", + "evaluationTitle", + "educationOrganizationId", + "evaluationDate", + "evaluationPeriodDescriptor", + "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": [ + "evaluationObjectiveTitle", + "educationOrganizationId", + "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": [ + "evaluationDate", + "evaluationTitle", + "performanceEvaluationTypeDescriptor", + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "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": [ + "evaluationTitle", + "educationOrganizationId", + "evaluationPeriodDescriptor", + "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", + "schoolYear", + "termDescriptor", + "personId", + "sourceSystemDescriptor" + ], + "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", + "schoolYear", + "termDescriptor", + "rubricRating" + ], + "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": [ + "personId", + "sourceSystemDescriptor", + "namespace", + "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": [ + "personId", + "sourceSystemDescriptor", + "namespace", + "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/progress.txt b/progress.txt index fa4804202..2aec196f8 100644 --- a/progress.txt +++ b/progress.txt @@ -44,3 +44,9 @@ Key decisions: audited focused Change Query OpenAPI coverage already added acros Files changed: tasks.json, progress.txt. Verification: OpenApiBaseDocumentEnhancer/OpenApiResourceFragmentEnhancer/OpenApiChangeQuerySchemaBuilder Jest, package tsc, package ESLint. Notes: authoritative artifact refresh still next; checked-in artifacts remain intentionally stale until authoritative-artifacts task. + +2026-06-10 - Completed authoritative-artifacts for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: accepted generated Change Query OpenAPI contract into v7.1/v7.2/v7.3 authoritatives; core artifacts carry changeQueries base doc; extension artifacts carry tracked-change fragments only; protected input fixtures untouched. +Files changed: v7_1/v7_2/v7_3 api-schema authoritative JSON artifacts, tasks.json, progress.txt. +Verification: updater dry-run copy set reviewed; v7.1/v7.2/v7.3 AuthoritativeCompare Jest pass; package tsc and ESLint pass; spot-checked /availableChangeVersions, /deletes, /keyChanges, extension no base docs, snapshot-only strings absent except model descriptions. +Notes: final validation task remains. diff --git a/tasks.json b/tasks.json index f513fd222..ff80d6a0f 100644 --- a/tasks.json +++ b/tasks.json @@ -174,7 +174,7 @@ "Run `npx ts-node packages/metaed-plugin-edfi-api-schema/test/integration/update-authoritative-files.ts --dry-run` from the repository root to confirm the generated-to-authoritative copy set before updating authoritative files.", "Review `git diff -- packages/metaed-plugin-edfi-api-schema/test/integration/artifact` before accepting the updates." ], - "completed": false + "completed": true }, { "category": "validation", From daf96fd2e190f0eaf70c39565657986135c28890 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 13:36:30 -0500 Subject: [PATCH 12/28] Validate Change Query OpenAPI output --- ...OpenApiGeneratedDocumentValidation.test.ts | 232 ++++++++++++++++++ progress.txt | 6 + tasks.json | 2 +- 3 files changed, 239 insertions(+), 1 deletion(-) create mode 100644 packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts 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..eda53e7fe --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts @@ -0,0 +1,232 @@ +// 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 { readFileSync } from 'node:fs'; +import path from 'path'; +import SwaggerParser from '@apidevtools/swagger-parser'; +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'; + +/** + * 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 }; + openApiBaseDocuments?: OpenApiBaseDocuments; + 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[]; +}; + +/** + * A core ApiSchema artifact and the extension artifacts compatible with it. + */ +type ValidationGroup = { + artifactDirectory: string; + coreArtifactFilename: string; + extensionArtifactFilenames: string[]; + scenarioName: string; +}; + +/** + * Groups of generated artifacts that compose into served OpenAPI documents. + */ +const validationGroups: ValidationGroup[] = [ + { + artifactDirectory: 'v7_1', + coreArtifactFilename: 'ds-5.0-api-schema-generated.json', + extensionArtifactFilenames: [], + scenarioName: 'ODS/API 7.1 data standard 5.0', + }, + { + artifactDirectory: 'v7_2', + coreArtifactFilename: 'ds-5.1-api-schema-generated.json', + extensionArtifactFilenames: ['tpdm-api-schema-generated.json'], + scenarioName: 'ODS/API 7.2 data standard 5.1 with TPDM', + }, + { + artifactDirectory: 'v7_3', + coreArtifactFilename: 'ds-5.2-api-schema-generated.json', + extensionArtifactFilenames: [ + 'homograph-api-schema-generated.json', + 'sample-api-schema-generated.json', + 'tpdm-api-schema-generated.json', + ], + scenarioName: 'ODS/API 7.3 data standard 5.2 with extensions', + }, + { + artifactDirectory: 'v7_3', + coreArtifactFilename: 'ds-6.0-api-schema-generated.json', + extensionArtifactFilenames: ['ds-6.0-homograph-api-schema-generated.json', 'ds-6.0-sample-api-schema-generated.json'], + scenarioName: 'ODS/API 7.3 data standard 6.0 with extensions', + }, + { + artifactDirectory: 'v7_3', + coreArtifactFilename: 'ds-6.1-api-schema-generated.json', + extensionArtifactFilenames: ['ds-6.1-homograph-api-schema-generated.json', 'ds-6.1-sample-api-schema-generated.json'], + scenarioName: 'ODS/API 7.3 data standard 6.1 with extensions', + }, +]; + +/** + * Reads a generated ApiSchema artifact from the integration artifact directory. + */ +function readArtifact(artifactDirectory: string, artifactFilename: string): ApiSchemaArtifact { + return JSON.parse(readFileSync(path.resolve(__dirname, 'artifact', artifactDirectory, artifactFilename), 'utf8')); +} + +/** + * 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); +} + +describe('generated OpenAPI documents', (): void => { + describe.each(validationGroups)('$scenarioName', (validationGroup: ValidationGroup): void => { + it('should validate merged resources, descriptors, and change queries documents', async (): Promise => { + const coreArtifact: ApiSchemaArtifact = readArtifact( + validationGroup.artifactDirectory, + validationGroup.coreArtifactFilename, + ); + const extensionArtifacts: ApiSchemaArtifact[] = validationGroup.extensionArtifactFilenames.map( + (extensionArtifactFilename: string): ApiSchemaArtifact => + readArtifact(validationGroup.artifactDirectory, extensionArtifactFilename), + ); + 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 documentsToValidate: Document[] = [ + changeQueriesBaseDocument as Document, + composeOpenApiDocument(descriptorsBaseDocument as Document, projectSchemas, OpenApiDocumentType.DESCRIPTORS), + composeOpenApiDocument(resourcesBaseDocument as Document, projectSchemas, OpenApiDocumentType.RESOURCES), + ]; + + await Promise.all(documentsToValidate.map(validateOpenApiDocument)); + }); + }); +}); diff --git a/progress.txt b/progress.txt index 2aec196f8..bac0603be 100644 --- a/progress.txt +++ b/progress.txt @@ -50,3 +50,9 @@ Key decisions: accepted generated Change Query OpenAPI contract into v7.1/v7.2/v Files changed: v7_1/v7_2/v7_3 api-schema authoritative JSON artifacts, tasks.json, progress.txt. Verification: updater dry-run copy set reviewed; v7.1/v7.2/v7.3 AuthoritativeCompare Jest pass; package tsc and ESLint pass; spot-checked /availableChangeVersions, /deletes, /keyChanges, extension no base docs, snapshot-only strings absent except model descriptions. Notes: final validation task remains. + +2026-06-10 - Completed validation for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: added generated OpenAPI composition validation with swagger-parser; validates core resources/descriptors/changeQueries plus compatible extension fragments; dedupes tags during composition; no artifact diffs expected. +Files changed: OpenApiGeneratedDocumentValidation.test.ts, tasks.json, progress.txt. +Verification: new validation Jest, Change Query focused Jest, v7.1/v7.2/v7.3 AuthoritativeCompare Jest, package tsc, package ESLint. +Notes: no npm run build used. diff --git a/tasks.json b/tasks.json index ff80d6a0f..11b780ac8 100644 --- a/tasks.json +++ b/tasks.json @@ -192,6 +192,6 @@ "Run the focused Jest tests for the changed package with `npx jest path/to/test.ts` from the repository root.", "Optionally validate merged OpenAPI documents with `@apidevtools/swagger-parser` if new full-document validation coverage is added." ], - "completed": false + "completed": true } ] From b430d0bd789661f3411870f7785e3593005527e5 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 15:05:29 -0500 Subject: [PATCH 13/28] build-fix --- ...OpenApiGeneratedDocumentValidation.test.ts | 268 +++++++++++++++--- tasks.json | 47 +++ 2 files changed, 280 insertions(+), 35 deletions(-) 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 index eda53e7fe..f0d023e9e 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts @@ -3,13 +3,36 @@ // 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 { readFileSync } from 'node:fs'; 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'; /** * OpenAPI base documents keyed by API metadata document type. @@ -39,7 +62,9 @@ type ResourceSchemaArtifact = { */ type ProjectSchemaArtifact = { abstractResources: { [resourceName: string]: AbstractResourceArtifact }; + isExtensionProject: boolean; openApiBaseDocuments?: OpenApiBaseDocuments; + projectName: string; resourceSchemas: { [endpointName: string]: ResourceSchemaArtifact }; }; @@ -63,60 +88,233 @@ type ComposedOpenApiDocument = Document & { }; /** - * A core ApiSchema artifact and the extension artifacts compatible with it. + * Project inputs needed to generate ApiSchema artifacts for a validation scenario. */ type ValidationGroup = { - artifactDirectory: string; - coreArtifactFilename: string; - extensionArtifactFilenames: string[]; + dataStandardVersion: SemVer; + defaultPluginTechVersion: SemVer; + projectPaths: string[]; + projects: MetaEdProject[]; scenarioName: string; }; /** - * Groups of generated artifacts that compose into served OpenAPI documents. + * Groups of MetaEd projects that compose into served OpenAPI documents. */ const validationGroups: ValidationGroup[] = [ { - artifactDirectory: 'v7_1', - coreArtifactFilename: 'ds-5.0-api-schema-generated.json', - extensionArtifactFilenames: [], + 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', }, { - artifactDirectory: 'v7_2', - coreArtifactFilename: 'ds-5.1-api-schema-generated.json', - extensionArtifactFilenames: ['tpdm-api-schema-generated.json'], + 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', }, { - artifactDirectory: 'v7_3', - coreArtifactFilename: 'ds-5.2-api-schema-generated.json', - extensionArtifactFilenames: [ - 'homograph-api-schema-generated.json', - 'sample-api-schema-generated.json', - 'tpdm-api-schema-generated.json', + 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', }, { - artifactDirectory: 'v7_3', - coreArtifactFilename: 'ds-6.0-api-schema-generated.json', - extensionArtifactFilenames: ['ds-6.0-homograph-api-schema-generated.json', 'ds-6.0-sample-api-schema-generated.json'], + 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', }, { - artifactDirectory: 'v7_3', - coreArtifactFilename: 'ds-6.1-api-schema-generated.json', - extensionArtifactFilenames: ['ds-6.1-homograph-api-schema-generated.json', 'ds-6.1-sample-api-schema-generated.json'], + 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', }, ]; /** - * Reads a generated ApiSchema artifact from the integration artifact directory. + * 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 readArtifact(artifactDirectory: string, artifactFilename: string): ApiSchemaArtifact { - return JSON.parse(readFileSync(path.resolve(__dirname, 'artifact', artifactDirectory, artifactFilename), 'utf8')); +function extensionArtifactsFrom(apiSchemaArtifacts: ApiSchemaArtifact[]): ApiSchemaArtifact[] { + return apiSchemaArtifacts.filter( + (apiSchemaArtifact: ApiSchemaArtifact): boolean => apiSchemaArtifact.projectSchema.isExtensionProject, + ); } /** @@ -196,15 +394,15 @@ async function validateOpenApiDocument(document: Document): Promise { describe.each(validationGroups)('$scenarioName', (validationGroup: ValidationGroup): void => { + let apiSchemaArtifacts: ApiSchemaArtifact[] = []; + + beforeAll(async (): Promise => { + apiSchemaArtifacts = await generatedApiSchemaArtifactsFor(validationGroup); + }); + it('should validate merged resources, descriptors, and change queries documents', async (): Promise => { - const coreArtifact: ApiSchemaArtifact = readArtifact( - validationGroup.artifactDirectory, - validationGroup.coreArtifactFilename, - ); - const extensionArtifacts: ApiSchemaArtifact[] = validationGroup.extensionArtifactFilenames.map( - (extensionArtifactFilename: string): ApiSchemaArtifact => - readArtifact(validationGroup.artifactDirectory, extensionArtifactFilename), - ); + const coreArtifact: ApiSchemaArtifact = coreArtifactFrom(apiSchemaArtifacts); + const extensionArtifacts: ApiSchemaArtifact[] = extensionArtifactsFrom(apiSchemaArtifacts); const projectSchemas: ProjectSchemaArtifact[] = [ coreArtifact.projectSchema, ...extensionArtifacts.map( diff --git a/tasks.json b/tasks.json index 11b780ac8..5b6e3b634 100644 --- a/tasks.json +++ b/tasks.json @@ -193,5 +193,52 @@ "Optionally validate merged OpenAPI documents with `@apidevtools/swagger-parser` if new full-document validation coverage is added." ], "completed": true + }, + { + "category": "openapi-generation", + "description": "Low: Keep tracked-change path emission and tracked-change schema emission consistent for every concrete Change Query resource.", + "acceptance-criteria": [ + "`createPathsFrom` does not emit `/deletes` or `/keyChanges` operations that reference tracked-change item schemas unless those schemas are emitted for the same fragment.", + "The implementation removes the silent concrete-resource path where `createTrackedChangeSchemasFrom` returns no schemas while tracked-change paths are still generated.", + "If a concrete generated resource cannot derive a public identity-key schema from semantic metadata, the output remains internally consistent and the case is covered by a focused test.", + "Generated core and extension OpenAPI fragments contain no dangling tracked-change `$ref` values." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts` from the repository root.", + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", + "Review generated OpenAPI fragments or the merged-document validation test output and confirm `/deletes` and `/keyChanges` response refs always resolve to emitted tracked-change schemas." + ], + "completed": false + }, + { + "category": "refactoring", + "description": "Low: Consolidate duplicated property-to-OpenAPI schema mapping used by tracked-change key schemas and standard OpenAPI query/resource schema generation.", + "acceptance-criteria": [ + "The scalar `EntityProperty` to OpenAPI `SchemaObject` mapping used by tracked-change key schema generation is shared with the existing OpenAPI generation path instead of being reimplemented in `OpenApiChangeQuerySchemaBuilder`.", + "The shared mapping preserves current generated output for descriptor URI strings, integers including `int64`, dates, date-times, strings with length constraints, booleans, decimals, school years, and years.", + "Tracked-change key schemas continue to derive field names from `queryFieldMapping` and do not introduce string parsing of resource names, component names, or JSONPath segments.", + "Focused tests cover at least one tracked-change identity field for each scalar category whose mapping is shared." + ], + "steps-to-verify": [ + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts` from the repository root.", + "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", + "Run `npx tsc -p packages/metaed-plugin-edfi-api-schema --noEmit` from the repository root." + ], + "completed": false + }, + { + "category": "repo-hygiene", + "description": "Low: Remove the root progress log artifact from the branch before merge.", + "acceptance-criteria": [ + "`progress.txt` is not committed as a root repository artifact unless the team intentionally documents and references it as part of the repository workflow.", + "Implementation progress history needed for this story remains represented by `tasks.json` or reviewed commit history rather than a standalone root log file.", + "The branch diff contains no unrelated process-log file changes outside the requested MetaEd implementation and task tracking." + ], + "steps-to-verify": [ + "Run `git ls-files progress.txt` from the repository root and confirm it returns no tracked file, or review the documented reason if the file is intentionally retained.", + "Run `git diff --name-status origin/main...HEAD -- progress.txt tasks.json` and confirm only intentional task-tracking changes remain.", + "Review the final branch diff for root-level process artifacts unrelated to the MetaEd OpenAPI implementation." + ], + "completed": false } ] From 72499803e797ec423e2f22742c000e9f6a6c3036 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 15:11:33 -0500 Subject: [PATCH 14/28] Fix tracked-change OpenAPI path schema consistency --- .../OpenApiResourceFragmentEnhancer.ts | 12 ++-- .../OpenApiSpecificationEnhancerBase.ts | 35 ++++++++--- .../OpenApiChangeQuerySchemaBuilder.test.ts | 8 +++ .../OpenApiResourceFragmentEnhancer.test.ts | 59 ++++++++++++++++++- progress.txt | 6 ++ tasks.json | 2 +- 6 files changed, 107 insertions(+), 15 deletions(-) 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 2be104fed..1e339f191 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts @@ -18,16 +18,18 @@ 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), - ...createTrackedChangeSchemasFrom(entity), + ...trackedChangeSchemas, }, }, }; @@ -37,7 +39,7 @@ export function createResourceFragment(entity: TopLevelEntity): OpenApiFragment return { ...fragment, - paths: createPathsFrom(entity), + paths: createPathsFrom(entity, trackedChangeSchemas), tags: createTagsFrom(entity), }; } @@ -46,12 +48,14 @@ 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), + paths: createPathsFrom(entity, trackedChangeSchemas), components: { schemas: { ...createSchemasFrom(entity), - ...createTrackedChangeSchemasFrom(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 43f0f807b..0d825048e 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts @@ -806,10 +806,24 @@ export function createSchemasFrom(entity: TopLevelEntity): Schemas { return schemas; } +/** + * Returns whether the tracked-change schemas needed by tracked-change paths are present. + */ +function hasTrackedChangePathSchemas( + trackedChangeSchemas: Schemas, + trackedChangeSchemaNames: TrackedChangeSchemaNames, +): boolean { + return ( + trackedChangeSchemas[trackedChangeSchemaNames.keyValues] != null && + trackedChangeSchemas[trackedChangeSchemaNames.deleteItem] != null && + trackedChangeSchemas[trackedChangeSchemaNames.keyChangeItem] != null + ); +} + /** * Creates the paths from a given TopLevelEntity */ -export function createPathsFrom(entity: TopLevelEntity): PathsObject { +export function createPathsFrom(entity: TopLevelEntity, trackedChangeSchemas: Schemas): PathsObject { const paths: PathsObject = {}; const projectEndpointName: ProjectEndpointName = createUriSegment(entity.namespace.projectName) as ProjectEndpointName; @@ -823,15 +837,18 @@ export function createPathsFrom(entity: TopLevelEntity): PathsObject { 'x-Ed-Fi-domains': domains, }; - paths[`${resourcePath}/deletes`] = { - get: createTrackedChangeDeletesSectionFor(entity, endpointName), - 'x-Ed-Fi-domains': domains, - }; + const trackedChangeSchemaNames: TrackedChangeSchemaNames = trackedChangeSchemaNamesFor(entity); + if (hasTrackedChangePathSchemas(trackedChangeSchemas, trackedChangeSchemaNames)) { + 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}/keyChanges`] = { + get: createTrackedChangeKeyChangesSectionFor(entity, endpointName), + 'x-Ed-Fi-domains': domains, + }; + } paths[`${resourcePath}/{id}`] = { get: createGetByIdSectionFor(entity, endpointName), 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 index d3691796b..bc86f9adf 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts @@ -199,6 +199,14 @@ describe('OpenApiChangeQuerySchemaBuilder', () => { }); }); + describe('when creating schemas for a concrete resource without public identity field metadata', () => { + const entity: TopLevelEntity = topLevelEntityWith('domainEntity', 'Student', false, {}); + + it('should not create tracked-change schemas', () => { + expect(createTrackedChangeSchemasFrom(entity)).toMatchInlineSnapshot(`Object {}`); + }); + }); + describe('when creating schemas for a descriptor', () => { const entity: TopLevelEntity = { type: 'descriptor', 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 5c8005cbc..a1452b1e4 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 @@ -39,13 +39,15 @@ import { enhance as allJsonPathsMappingEnhancer } from '../../src/enhancer/AllJs 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'; @@ -162,6 +164,7 @@ function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment) { resourceNameEnhancer(metaEd); documentPathsMappingEnhancer(metaEd); identityFullnameEnhancer(metaEd); + subclassIdentityFullnameEnhancer(metaEd); queryFieldMappingEnhancer(metaEd); identityJsonPathsEnhancer(metaEd); typeCoercionJsonPathsEnhancer(metaEd); @@ -170,6 +173,43 @@ 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], + 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(); @@ -359,6 +399,23 @@ describe('OpenApiResourceFragmentEnhancer', () => { }); }); + describe('when creating a resource fragment without public tracked-change key metadata', () => { + const fragment: OpenApiFragment = createResourceFragment(concreteResourceWithoutPublicTrackedChangeKeyMetadata()); + + it('should omit tracked-change paths that would reference missing schemas', () => { + const trackedChangeSchemaNames: string[] = Object.keys(fragment.components.schemas).filter((schemaName: string) => + schemaName.includes('_TrackedChange'), + ); + + expect(fragment.paths?.['/ed-fi/students']).toBeDefined(); + expect(fragment.paths?.['/ed-fi/students/{id}']).toBeDefined(); + expect(fragment.paths?.['/ed-fi/students/deletes']).toBeUndefined(); + expect(fragment.paths?.['/ed-fi/students/keyChanges']).toBeUndefined(); + expect(trackedChangeSchemaNames).toEqual([]); + expect(JSON.stringify(fragment)).not.toContain('_TrackedChange'); + }); + }); + describe('when enhancing a descriptor', () => { const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); diff --git a/progress.txt b/progress.txt index bac0603be..b576b0435 100644 --- a/progress.txt +++ b/progress.txt @@ -56,3 +56,9 @@ Key decisions: added generated OpenAPI composition validation with swagger-parse Files changed: OpenApiGeneratedDocumentValidation.test.ts, tasks.json, progress.txt. Verification: new validation Jest, Change Query focused Jest, v7.1/v7.2/v7.3 AuthoritativeCompare Jest, package tsc, package ESLint. Notes: no npm run build used. + +2026-06-10 - Completed openapi-generation tracked-change path/schema consistency for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: createResourceFragment/createDescriptorFragment compute tracked-change schemas once and pass same set to createPathsFrom; createPathsFrom gates /deletes and /keyChanges on emitted key/delete/keyChange schemas; focused no-public-identity case omits tracked-change paths instead of dangling refs; resource fragment test harness now includes SubclassIdentityFullnameEnhancer to mirror real enhancer order. +Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiResourceFragmentEnhancer.ts, OpenApiChangeQuerySchemaBuilder.test.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. +Verification: OpenApiChangeQuerySchemaBuilder Jest, OpenApiResourceFragmentEnhancer Jest, package tsc, package ESLint, OpenApiGeneratedDocumentValidation Jest. +Notes: no artifact diffs expected; no npm run build used. Existing uncommitted tasks.json hygiene-task deletion was left as pre-existing work. diff --git a/tasks.json b/tasks.json index 5b6e3b634..2a5440673 100644 --- a/tasks.json +++ b/tasks.json @@ -208,7 +208,7 @@ "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", "Review generated OpenAPI fragments or the merged-document validation test output and confirm `/deletes` and `/keyChanges` response refs always resolve to emitted tracked-change schemas." ], - "completed": false + "completed": true }, { "category": "refactoring", From 68eabbbdade55cfa868c7768d21d39993a274768 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 15:17:24 -0500 Subject: [PATCH 15/28] Refactor OpenAPI schema property mapping --- .../OpenApiChangeQuerySchemaBuilder.ts | 57 +---- .../OpenApiEntityPropertySchemaMapper.ts | 66 +++++ .../OpenApiSpecificationEnhancerBase.ts | 62 +---- .../OpenApiChangeQuerySchemaBuilder.test.ts | 237 +++++++++++++++++- progress.txt | 6 + tasks.json | 2 +- 6 files changed, 309 insertions(+), 121 deletions(-) create mode 100644 packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiEntityPropertySchemaMapper.ts diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts index e1a71edf5..964ac4eea 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts @@ -3,13 +3,7 @@ // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. // See the LICENSE and NOTICES files in the project root for more information. -import { - type DomainEntity, - type EntityProperty, - type IntegerProperty, - type StringProperty, - type TopLevelEntity, -} from '@edfi/metaed-core'; +import { type DomainEntity, type TopLevelEntity } from '@edfi/metaed-core'; import type { EntityApiSchemaData } from '../model/EntityApiSchemaData'; import type { JsonPath } from '../model/api-schema/JsonPath'; import type { PathType } from '../model/api-schema/PathType'; @@ -17,6 +11,7 @@ import type { QueryFieldMapping } from '../model/api-schema/QueryFieldMapping'; import type { QueryFieldPathInfo } from '../model/api-schema/QueryFieldPathInfo'; import type { SchemaObject, Schemas } from '../model/OpenApiTypes'; import { deAcronym, normalizeDescriptorName } from '../Utility'; +import { schemaObjectFromEntityProperty } from './OpenApiEntityPropertySchemaMapper'; /** * Component schema names used by tracked-change OpenAPI response schemas. @@ -98,59 +93,13 @@ function schemaObjectFromPathType(pathType: PathType): SchemaObject { } } -/** - * Creates an OpenAPI schema object from source property semantic type metadata. - */ -function schemaObjectFromSourceProperty(sourceProperty: EntityProperty): SchemaObject { - switch (sourceProperty.type) { - case 'boolean': - return { type: 'boolean' }; - 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 'duration': - return { type: 'string', maxLength: 30 }; - case 'integer': - case 'sharedInteger': { - const integerProperty: IntegerProperty = sourceProperty 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 stringProperty: StringProperty = sourceProperty as StringProperty; - const result: SchemaObject = { type: 'string' }; - 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: 'string' }; - } -} - /** * Creates an OpenAPI schema object from query field path metadata. */ function schemaObjectFromQueryFieldPathInfo(pathInfo: QueryFieldPathInfo): SchemaObject { if (pathInfo.sourceProperty == null) return schemaObjectFromPathType(pathInfo.type); - return schemaObjectFromSourceProperty(pathInfo.sourceProperty); + return schemaObjectFromEntityProperty(pathInfo.sourceProperty, { type: 'string' }); } /** 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/OpenApiSpecificationEnhancerBase.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts index 0d825048e..680031b96 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, @@ -22,6 +21,7 @@ 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 @@ -342,62 +342,6 @@ function newStaticTrackedChangeQueryParameters(): Parameter[] { ]; } -/** - * Returns an OpenAPI schema object corresponding to the given property based on its type. - */ -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' }; - } -} - // All descriptor documents have the same OpenAPI get by query parameters const descriptorOpenApiParameters: Parameter[] = [ { @@ -489,7 +433,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 }), }; 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 index bc86f9adf..6f7bc4bc2 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts @@ -12,8 +12,30 @@ import { } from '@edfi/metaed-core'; import { createTrackedChangeSchemasFrom } from '../../src/enhancer/OpenApiChangeQuerySchemaBuilder'; import type { JsonPath } from '../../src/model/api-schema/JsonPath'; +import type { PathType } from '../../src/model/api-schema/PathType'; import type { QueryFieldMapping } from '../../src/model/api-schema/QueryFieldMapping'; +/** + * A tracked-change identity source property case used to verify scalar OpenAPI schema mapping. + */ +type ScalarIdentitySourcePropertyCase = { + fieldName: string; + identityJsonPath: JsonPath; + pathType: PathType; + 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. */ @@ -39,6 +61,18 @@ function integerSourceProperty(): EntityProperty { } 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. */ @@ -50,6 +84,99 @@ function descriptorSourceProperty(): EntityProperty { }; } +/** + * Creates source property cases for tracked-change scalar schema mapping tests. + */ +function scalarIdentitySourcePropertyCases(): ScalarIdentitySourcePropertyCase[] { + return [ + { + fieldName: 'booleanIdentity', + identityJsonPath: '$.booleanIdentity' as JsonPath, + pathType: 'boolean', + sourceProperty: sourcePropertyOfType('boolean', 'Boolean identity field'), + }, + { + fieldName: 'dateIdentity', + identityJsonPath: '$.dateIdentity' as JsonPath, + pathType: 'date', + sourceProperty: sourcePropertyOfType('date', 'Date identity field'), + }, + { + fieldName: 'dateTimeIdentity', + identityJsonPath: '$.dateTimeIdentity' as JsonPath, + pathType: 'date-time', + sourceProperty: sourcePropertyOfType('datetime', 'Date-time identity field'), + }, + { + fieldName: 'decimalIdentity', + identityJsonPath: '$.decimalIdentity' as JsonPath, + pathType: 'number', + sourceProperty: sourcePropertyOfType('decimal', 'Decimal identity field'), + }, + { + fieldName: 'descriptorIdentity', + identityJsonPath: '$.descriptorIdentity' as JsonPath, + pathType: 'string', + sourceProperty: descriptorSourceProperty(), + }, + { + fieldName: 'durationIdentity', + identityJsonPath: '$.durationIdentity' as JsonPath, + pathType: 'string', + sourceProperty: sourcePropertyOfType('duration', 'Duration identity field'), + }, + { + fieldName: 'int64Identity', + identityJsonPath: '$.int64Identity' as JsonPath, + pathType: 'number', + sourceProperty: bigIntegerSourceProperty(), + }, + { + fieldName: 'schoolYearIdentity', + identityJsonPath: '$.schoolYearIdentity' as JsonPath, + pathType: 'number', + sourceProperty: sourcePropertyOfType('schoolYearEnumeration', 'School year identity field'), + }, + { + fieldName: 'stringIdentity', + identityJsonPath: '$.stringIdentity' as JsonPath, + pathType: 'string', + sourceProperty: stringSourceProperty(), + }, + { + fieldName: 'timeIdentity', + identityJsonPath: '$.timeIdentity' as JsonPath, + pathType: 'time', + sourceProperty: sourcePropertyOfType('time', 'Time identity field'), + }, + { + fieldName: 'yearIdentity', + identityJsonPath: '$.yearIdentity' as JsonPath, + pathType: 'number', + sourceProperty: sourcePropertyOfType('year', 'Year identity field'), + }, + ]; +} + +/** + * Creates query field mapping metadata from scalar source property cases. + */ +function queryFieldMappingFrom(sourcePropertyCases: ScalarIdentitySourcePropertyCase[]): QueryFieldMapping { + const result: QueryFieldMapping = {}; + + sourcePropertyCases.forEach((sourcePropertyCase: ScalarIdentitySourcePropertyCase) => { + result[sourcePropertyCase.fieldName] = [ + { + path: sourcePropertyCase.identityJsonPath, + type: sourcePropertyCase.pathType, + sourceProperty: sourcePropertyCase.sourceProperty, + }, + ]; + }); + + return result; +} + /** * Creates regular resource query field mapping metadata for tracked-change schema tests. */ @@ -87,12 +214,13 @@ function regularResourceQueryFieldMapping(): QueryFieldMapping { } /** - * Creates a top-level entity with only the data needed by tracked-change schema generation. + * Creates a top-level entity with explicit identity paths for tracked-change schema generation. */ -function topLevelEntityWith( +function topLevelEntityWithIdentityJsonPaths( type: string, metaEdName: string, isAbstract: boolean, + identityJsonPaths: JsonPath[], queryFieldMapping: QueryFieldMapping, ): TopLevelEntity { return { @@ -104,17 +232,35 @@ function topLevelEntityWith( }, data: { edfiApiSchema: { - identityJsonPaths: [ - '$.entryGradeLevelDescriptor' as JsonPath, - '$.schoolReference.schoolId' as JsonPath, - '$.studentReference.studentUniqueId' as JsonPath, - ], + identityJsonPaths, queryFieldMapping, }, }, } 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, + queryFieldMapping: QueryFieldMapping, +): TopLevelEntity { + return topLevelEntityWithIdentityJsonPaths( + type, + metaEdName, + isAbstract, + [ + '$.entryGradeLevelDescriptor' as JsonPath, + '$.schoolReference.schoolId' as JsonPath, + '$.studentReference.studentUniqueId' as JsonPath, + ], + queryFieldMapping, + ); +} + describe('OpenApiChangeQuerySchemaBuilder', () => { describe('when creating schemas for a regular resource', () => { const entity: TopLevelEntity = topLevelEntityWith( @@ -199,6 +345,83 @@ describe('OpenApiChangeQuerySchemaBuilder', () => { }); }); + describe('when creating key schemas from scalar identity source properties', () => { + const sourcePropertyCases: ScalarIdentitySourcePropertyCase[] = scalarIdentitySourcePropertyCases(); + const entity: TopLevelEntity = topLevelEntityWithIdentityJsonPaths( + 'domainEntity', + 'ScalarIdentityResource', + false, + sourcePropertyCases.map((sourcePropertyCase: ScalarIdentitySourcePropertyCase) => sourcePropertyCase.identityJsonPath), + queryFieldMappingFrom(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 public identity field metadata', () => { const entity: TopLevelEntity = topLevelEntityWith('domainEntity', 'Student', false, {}); diff --git a/progress.txt b/progress.txt index b576b0435..5d37181a9 100644 --- a/progress.txt +++ b/progress.txt @@ -62,3 +62,9 @@ Key decisions: createResourceFragment/createDescriptorFragment compute tracked-c Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiResourceFragmentEnhancer.ts, OpenApiChangeQuerySchemaBuilder.test.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. Verification: OpenApiChangeQuerySchemaBuilder Jest, OpenApiResourceFragmentEnhancer Jest, package tsc, package ESLint, OpenApiGeneratedDocumentValidation Jest. Notes: no artifact diffs expected; no npm run build used. Existing uncommitted tasks.json hygiene-task deletion was left as pre-existing work. + +2026-06-10 - Completed refactoring scalar OpenAPI schema mapper for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md +Key decisions: extracted shared EntityProperty to OpenAPI SchemaObject mapper used by GET-many query params and tracked-change key schemas; preserved caller-specific unsupported-type fallbacks; kept tracked-change identity field names semantic via queryFieldMapping. +Files changed: OpenApiEntityPropertySchemaMapper.ts, OpenApiSpecificationEnhancerBase.ts, OpenApiChangeQuerySchemaBuilder.ts, OpenApiChangeQuerySchemaBuilder.test.ts, tasks.json, progress.txt. +Verification: OpenApiChangeQuerySchemaBuilder Jest, OpenApiResourceFragmentEnhancer Jest, package tsc, package ESLint. +Notes: no artifact diffs expected; no npm run build used. Existing uncommitted tasks.json hygiene-task deletion remains unrelated pre-existing work. diff --git a/tasks.json b/tasks.json index 2a5440673..daaad82ad 100644 --- a/tasks.json +++ b/tasks.json @@ -224,7 +224,7 @@ "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", "Run `npx tsc -p packages/metaed-plugin-edfi-api-schema --noEmit` from the repository root." ], - "completed": false + "completed": true }, { "category": "repo-hygiene", From ac4baa49ebb5c2a3777289c44cc19ae295b370d5 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 15:28:37 -0500 Subject: [PATCH 16/28] Remove implementation progress log --- progress.txt | 70 ---------------------------------------------------- tasks.json | 2 +- 2 files changed, 1 insertion(+), 71 deletions(-) delete mode 100644 progress.txt diff --git a/progress.txt b/progress.txt deleted file mode 100644 index 5d37181a9..000000000 --- a/progress.txt +++ /dev/null @@ -1,70 +0,0 @@ -2026-06-10 - Completed schema-contract for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: added changeQueries OpenAPI document type; OpenApiBaseDocumentEnhancer emits empty core-only changeQueries base doc; ApiSchemaBuildingEnhancer copies openApiBaseDocuments only for non-extension namespaces; apiSchemaVersion stays 1.0.0. -Files changed: OpenApiDocumentType.ts, Namespace.ts, ProjectSchema.ts, OpenApiBaseDocumentEnhancer.ts, ApiSchemaBuildingEnhancer.ts, OpenApiBaseDocumentEnhancer.test.ts, ApiSchemaBuildingEnhancer.test.ts, tasks.json, progress.txt. -Verification: OpenApiBaseDocumentEnhancer Jest, ApiSchemaBuildingEnhancer Jest, package tsc, package ESLint, generator spot-check core has resources/descriptors/changeQueries and extension omits openApiBaseDocuments. -Notes: authoritative artifact refresh intentionally deferred to authoritative-artifacts task; next task should populate /availableChangeVersions in changeQueries.paths. - -2026-06-10 - Completed openapi-generation availableChangeVersions for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: changeQueries base doc now specializes paths/components; emits only ODS-style /availableChangeVersions path; 200 body has required oldestChangeVersion/newestChangeVersion integer int64; no inherited query params, snapshot components, OAuth/security. -Files changed: OpenApiBaseDocumentEnhancer.ts, OpenApiBaseDocumentEnhancer.test.ts, tasks.json, progress.txt. -Verification: OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint. Authoritative artifact refresh still deferred to authoritative-artifacts task. - -2026-06-10 - Completed semantic-modeling tracked-change schemas for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: added reusable OpenApiChangeQuerySchemaBuilder; exact identityJsonPaths-to-queryFieldMapping matching; descriptor keys are namespace/codeValue; descriptor references stay public URI strings; abstract resources emit no tracked-change schemas; SchoolYear gets semantic $.schoolYear identity metadata. -Files changed: OpenApiChangeQuerySchemaBuilder.ts, OpenApiResourceFragmentEnhancer.ts, IdentityJsonPathsEnhancer.ts, EntityApiSchemaData.ts, OpenApiChangeQuerySchemaBuilder.test.ts, IdentityJsonPathsEnhancer.test.ts, tasks.json, progress.txt. -Verification: OpenApiChangeQuerySchemaBuilder Jest, OpenApiResourceFragmentEnhancer Jest, IdentityJsonPathsEnhancer Jest, package tsc, package ESLint. -Notes: components now exist for later /deletes and /keyChanges path wiring; authoritative artifact refresh still deferred. - -2026-06-10 - Completed openapi-generation snapshot cleanup for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: removed shared NotFoundUseSnapshot response; GET-many and GET-by-id now use NotFound; GET-by-id no longer emits Use-Snapshot header; write/delete 405 descriptions are generic. -Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiBaseDocumentEnhancer.test.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. -Verification: OpenApiResourceFragmentEnhancer Jest, OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint, source search for snapshot OpenAPI strings. -Notes: checked-in integration artifacts still reflect old output and remain deferred to authoritative-artifacts task. - -2026-06-10 - Completed openapi-generation live Change Query filters for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: existing shared GET-many parameter builder already emits MinChangeVersion/MaxChangeVersion with int64 component definitions; completed task by adding focused fragment coverage for core resource, descriptor, SchoolYearType, extension-defined resource/descriptor, and resource-extension overlay exclusion. -Files changed: OpenApiResourceFragmentEnhancer.test.ts, OpenApiBaseDocumentEnhancer.test.ts, tasks.json, progress.txt. -Verification: OpenApiResourceFragmentEnhancer Jest, OpenApiBaseDocumentEnhancer Jest, package tsc, package ESLint. -Notes: no source behavior change and no artifact refresh; checked-in artifacts already contained live GET-many change-version refs. - -2026-06-10 - Completed openapi-generation tracked-change paths for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: createPathsFrom now emits sibling /deletes and /keyChanges GET paths for generated resources/descriptors; operations use MinChangeVersion/MaxChangeVersion/limit/offset/totalCount refs only; responses are application/json arrays referencing per-resource tracked-change schemas; resource extensions still no standalone paths. -Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. -Verification: OpenApiResourceFragmentEnhancer Jest, ApiSchemaBuildingEnhancer Jest, package tsc, package ESLint. -Notes: authoritative artifact refresh intentionally deferred to authoritative-artifacts task; compare tests expected to differ until artifacts are updated. - -2026-06-10 - Completed profile-integration for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: locked MetaEd side of profile contract in unit coverage; fragments keep unprofiled resource-specific tracked-change schemas/refs, key-only schemas, application/json responses, sibling /deletes and /keyChanges paths under parent collection; no /availableChangeVersions duplication in resource fragments. Test harness now runs plugin prerequisite enhancers and QueryFieldMappingEnhancer so tracked-change refs are backed by schemas. -Files changed: OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. -Verification: OpenApiResourceFragmentEnhancer Jest, package tsc, package ESLint. -Notes: no source behavior change; authoritative artifact refresh still deferred. - -2026-06-10 - Completed tests for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: audited focused Change Query OpenAPI coverage already added across base document, resource fragment, and schema builder suites; no extra assertions needed for task contract. -Files changed: tasks.json, progress.txt. -Verification: OpenApiBaseDocumentEnhancer/OpenApiResourceFragmentEnhancer/OpenApiChangeQuerySchemaBuilder Jest, package tsc, package ESLint. -Notes: authoritative artifact refresh still next; checked-in artifacts remain intentionally stale until authoritative-artifacts task. - -2026-06-10 - Completed authoritative-artifacts for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: accepted generated Change Query OpenAPI contract into v7.1/v7.2/v7.3 authoritatives; core artifacts carry changeQueries base doc; extension artifacts carry tracked-change fragments only; protected input fixtures untouched. -Files changed: v7_1/v7_2/v7_3 api-schema authoritative JSON artifacts, tasks.json, progress.txt. -Verification: updater dry-run copy set reviewed; v7.1/v7.2/v7.3 AuthoritativeCompare Jest pass; package tsc and ESLint pass; spot-checked /availableChangeVersions, /deletes, /keyChanges, extension no base docs, snapshot-only strings absent except model descriptions. -Notes: final validation task remains. - -2026-06-10 - Completed validation for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: added generated OpenAPI composition validation with swagger-parser; validates core resources/descriptors/changeQueries plus compatible extension fragments; dedupes tags during composition; no artifact diffs expected. -Files changed: OpenApiGeneratedDocumentValidation.test.ts, tasks.json, progress.txt. -Verification: new validation Jest, Change Query focused Jest, v7.1/v7.2/v7.3 AuthoritativeCompare Jest, package tsc, package ESLint. -Notes: no npm run build used. - -2026-06-10 - Completed openapi-generation tracked-change path/schema consistency for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: createResourceFragment/createDescriptorFragment compute tracked-change schemas once and pass same set to createPathsFrom; createPathsFrom gates /deletes and /keyChanges on emitted key/delete/keyChange schemas; focused no-public-identity case omits tracked-change paths instead of dangling refs; resource fragment test harness now includes SubclassIdentityFullnameEnhancer to mirror real enhancer order. -Files changed: OpenApiSpecificationEnhancerBase.ts, OpenApiResourceFragmentEnhancer.ts, OpenApiChangeQuerySchemaBuilder.test.ts, OpenApiResourceFragmentEnhancer.test.ts, tasks.json, progress.txt. -Verification: OpenApiChangeQuerySchemaBuilder Jest, OpenApiResourceFragmentEnhancer Jest, package tsc, package ESLint, OpenApiGeneratedDocumentValidation Jest. -Notes: no artifact diffs expected; no npm run build used. Existing uncommitted tasks.json hygiene-task deletion was left as pre-existing work. - -2026-06-10 - Completed refactoring scalar OpenAPI schema mapper for /home/brad/work/dms-root/Data-Management-Service/reference/design/backend-redesign/epics/10-update-tracking-change-queries/20-openapi-change-query-surface.md -Key decisions: extracted shared EntityProperty to OpenAPI SchemaObject mapper used by GET-many query params and tracked-change key schemas; preserved caller-specific unsupported-type fallbacks; kept tracked-change identity field names semantic via queryFieldMapping. -Files changed: OpenApiEntityPropertySchemaMapper.ts, OpenApiSpecificationEnhancerBase.ts, OpenApiChangeQuerySchemaBuilder.ts, OpenApiChangeQuerySchemaBuilder.test.ts, tasks.json, progress.txt. -Verification: OpenApiChangeQuerySchemaBuilder Jest, OpenApiResourceFragmentEnhancer Jest, package tsc, package ESLint. -Notes: no artifact diffs expected; no npm run build used. Existing uncommitted tasks.json hygiene-task deletion remains unrelated pre-existing work. diff --git a/tasks.json b/tasks.json index daaad82ad..c2f7c1207 100644 --- a/tasks.json +++ b/tasks.json @@ -239,6 +239,6 @@ "Run `git diff --name-status origin/main...HEAD -- progress.txt tasks.json` and confirm only intentional task-tracking changes remain.", "Review the final branch diff for root-level process artifacts unrelated to the MetaEd OpenAPI implementation." ], - "completed": false + "completed": true } ] From b3c06f310918f87cf58738aff03b972310cb7286 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 16:01:43 -0500 Subject: [PATCH 17/28] ok --- tasks.json | 244 ----------------------------------------------------- 1 file changed, 244 deletions(-) delete mode 100644 tasks.json diff --git a/tasks.json b/tasks.json deleted file mode 100644 index c2f7c1207..000000000 --- a/tasks.json +++ /dev/null @@ -1,244 +0,0 @@ -[ - { - "category": "schema-contract", - "description": "Extend the MetaEd API Schema OpenAPI document contract so `projectSchema.openApiBaseDocuments.changeQueries` can be emitted as an optional core-only base document.", - "acceptance-criteria": [ - "`OpenApiDocumentType` and related `NamespaceEdfiApiSchema` and `ProjectSchema` types accept a `changeQueries` document key alongside `resources` and `descriptors`.", - "Core/data-standard namespaces can carry `openApiBaseDocuments.changeQueries`; extension namespaces do not emit that standalone base document.", - "`ApiSchemaBuildingEnhancer` copies the optional `changeQueries` base document into core `projectSchema.openApiBaseDocuments` without adding the key to extension project schemas.", - "The existing `resources` and `descriptors` base document behavior remains unchanged except for explicit snapshot cleanup handled in a separate task.", - "`apiSchemaVersion` remains `1.0.0` because the new document is OpenAPI-only metadata under `openApiBaseDocuments`.", - "All new or changed exported types and functions have summary JSDoc comments and explicit TypeScript annotations." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", - "Run `npx tsc -p packages/metaed-plugin-edfi-api-schema --noEmit` from the repository root.", - "Review a generated core ApiSchema JSON artifact under `packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm `projectSchema.openApiBaseDocuments.changeQueries` is present only for the core project." - ], - "completed": true - }, - { - "category": "openapi-generation", - "description": "Generate the standalone Change-Queries OpenAPI base document that advertises `GET /availableChangeVersions` for DMS metadata discovery.", - "acceptance-criteria": [ - "The core `openApiBaseDocuments.changeQueries` document contains the ODS-style path key `/availableChangeVersions`, not `/changeQueries/v1/availableChangeVersions`.", - "The `GET /availableChangeVersions` operation exposes a `200` `application/json` object response with required `oldestChangeVersion` and `newestChangeVersion` integer `int64` properties.", - "The `GET /availableChangeVersions` operation has no advertised query parameters, including resource or descriptor parameters such as `minChangeVersion`, `maxChangeVersion`, `limit`, `offset`, `totalCount`, `pageToken`, or `pageSize`.", - "The standalone document does not include resource or descriptor paths, and resource/descriptor documents do not include `/availableChangeVersions`.", - "The standalone document does not emit deployment-specific OAuth2 security schemes, root `security`, token URLs, or runtime server URLs that DMS must inject at serve time.", - "The standalone document does not include snapshot headers, snapshot response descriptions, or snapshot-specific response components." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_3.test.ts` from the repository root after updating authoritative artifacts if generated artifacts changed.", - "Inspect `projectSchema.openApiBaseDocuments.changeQueries.paths` in a generated core ApiSchema artifact under `packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3` and confirm it contains only `/availableChangeVersions`." - ], - "completed": true - }, - { - "category": "openapi-generation", - "description": "Remove snapshot-only OpenAPI artifacts from the DMS OpenAPI documents emitted by `metaed-plugin-edfi-api-schema`.", - "acceptance-criteria": [ - "Generated resource, descriptor, and Change-Queries OpenAPI documents do not define or reference `Use-Snapshot` header parameters.", - "Generated resource, descriptor, and Change-Queries OpenAPI documents do not define or reference the shared `NotFoundUseSnapshot` response.", - "Generated GET-by-query and GET-by-id operations use non-snapshot not-found responses and descriptions.", - "Generated write and delete operation responses do not include snapshot-specific `405 Method Is Not Allowed` descriptions.", - "No generated OpenAPI fragment or base document contains the text `Use-Snapshot` or snapshot-only response wording." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", - "Search generated ApiSchema artifacts with `rg \"Use-Snapshot|NotFoundUseSnapshot|snapshot\" packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm remaining matches are outside DMS OpenAPI output or are intentionally unrelated model text." - ], - "completed": true - }, - { - "category": "semantic-modeling", - "description": "Build reusable OpenAPI schema generation for Change Query identity-key response payloads from existing semantic API Schema metadata.", - "acceptance-criteria": [ - "Regular resource tracked-change key schemas are derived by correlating exact `identityJsonPaths` values with `queryFieldMapping` and `QueryFieldPathInfo` source-property metadata, without parsing endpoint names, component names, or JSONPath segments.", - "Regular resource key schemas expose public query-field names for identity fields and omit internal storage identifiers.", - "Descriptor tracked-change key schemas use required public `namespace` and `codeValue` properties because descriptor `identityJsonPaths` is intentionally empty.", - "Descriptor-reference identity fields in regular resource key schemas are represented as public descriptor URI string fields rather than internal descriptor IDs.", - "Concrete abstract resources that materialize as endpoints derive tracked-change key schemas from their concrete resource schema and identity metadata, while abstract schema-only resources do not receive tracked-change response schemas.", - "Tracked-change response item `id` properties are represented as strings.", - "`/deletes` item schemas require `id`, `changeVersion`, and `keyValues`; `/keyChanges` item schemas require `id`, `changeVersion`, `oldKeyValues`, and `newKeyValues`.", - "Every generated key object schema marks each identity property as required and uses the JSON schema type information available from existing API Schema metadata.", - "`changeVersion`, `minChangeVersion`, and `maxChangeVersion` are represented consistently as integer `int64` values." - ], - "steps-to-verify": [ - "Run focused unit tests for the new tracked-change schema helper, for example `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` or a new helper-specific test file from the repository root.", - "Review inline snapshots for a regular resource with scalar and reference identity fields.", - "Review inline snapshots for a descriptor and confirm only `namespace` and `codeValue` appear in key schemas." - ], - "completed": true - }, - { - "category": "openapi-generation", - "description": "Advertise live Change Query window filters on existing resource and descriptor GET-many OpenAPI operations.", - "acceptance-criteria": [ - "Every generated regular resource GET-many operation includes `minChangeVersion` and `maxChangeVersion` query parameters.", - "Every generated descriptor GET-many operation includes `minChangeVersion` and `maxChangeVersion` query parameters.", - "`SchoolYearType` GET-many OpenAPI output includes `minChangeVersion` and `maxChangeVersion` because it is treated as a regular Change Query resource.", - "Extension-defined top-level resource and descriptor GET-many operations include the same change-version query parameters under their extension project endpoint.", - "Resource-extension overlays under `_ext` do not receive standalone live Change Query filter parameters because they are not standalone endpoints.", - "The live GET-many parameters are not added to GET-by-id, POST, PUT, DELETE, `/deletes`, `/keyChanges`, or `/availableChangeVersions` operations through this task.", - "`minChangeVersion` and `maxChangeVersion` are represented consistently with the ChangeVersion contract as integer `int64` query parameters.", - "No `Use-Snapshot` parameter or snapshot-specific response is introduced while adding the live change-version parameters." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", - "Inspect generated resource and descriptor OpenAPI fragments for a core resource, descriptor, `SchoolYearType`, and extension-defined resource.", - "Search generated ApiSchema artifacts with `rg \"minChangeVersion|maxChangeVersion|Use-Snapshot\" packages/metaed-plugin-edfi-api-schema/test/integration/artifact` and confirm change-version parameters appear only on expected operations and `Use-Snapshot` is absent from DMS OpenAPI output." - ], - "completed": true - }, - { - "category": "openapi-generation", - "description": "Emit `/deletes` and `/keyChanges` OpenAPI paths for generated resources and descriptors that support Change Query discovery.", - "acceptance-criteria": [ - "Every non-composite generated regular resource in the resources OpenAPI fragments advertises `/{projectEndpointName}/{resourceEndpoint}/deletes` and `/{projectEndpointName}/{resourceEndpoint}/keyChanges`.", - "Every generated descriptor in the descriptors OpenAPI fragments advertises `/{projectEndpointName}/{descriptorEndpoint}/deletes` and `/{projectEndpointName}/{descriptorEndpoint}/keyChanges`.", - "Tracked-change endpoint advertisement is driven by generated resource and descriptor OpenAPI fragments, not by claim/action metadata, `ReadChanges` authorization strategies, or runtime tracked-change inventory.", - "`SchoolYearType` is treated as a regular Change Query resource and advertises both tracked-change paths.", - "Concrete abstract resources that materialize as endpoints advertise both tracked-change paths under their concrete endpoint names.", - "Extension-defined top-level resources and descriptors advertise tracked-change paths under their extension project endpoint.", - "Resource-extension overlays under `_ext` do not receive standalone `/deletes` or `/keyChanges` paths.", - "Abstract resources that do not materialize to endpoints continue to emit schemas only and do not receive tracked-change paths.", - "Tracked-change paths are emitted as `get` operations on sibling collection subpaths, not as operations under `/{id}` paths.", - "`/deletes` and `/keyChanges` operations include `minChangeVersion`, `maxChangeVersion`, `limit`, `offset`, and `totalCount` query parameters.", - "`minChangeVersion` and `maxChangeVersion` query parameters use integer `int64`; `limit` and `offset` use integer `int32`; `totalCount` uses a boolean schema with default `false`, matching existing component parameter conventions.", - "`/deletes` and `/keyChanges` operations do not include cursor-paging parameters such as `pageToken` or `pageSize`, and do not inherit live resource query-field filters.", - "`/deletes` and `/keyChanges` operations expose `200` `application/json` array responses that reference the generated delete item and key-change item schemas." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/ApiSchemaBuildingEnhancer.test.ts` from the repository root if ResourceSchema copying behavior changes.", - "Inspect generated core and extension ApiSchema artifacts for representative resource, descriptor, `SchoolYearType`, and resource-extension cases." - ], - "completed": true - }, - { - "category": "profile-integration", - "description": "Make the MetaEd-emitted tracked-change OpenAPI fragments compatible with DMS profile-specific OpenAPI filtering and schema suffixing.", - "acceptance-criteria": [ - "Tracked-change response component names are deterministic and resource-specific so DMS can create profile-suffixed tracked-change schemas without colliding with normal resource representation schemas.", - "MetaEd emits stable unprofiled tracked-change component names and references; profile-specific suffixing remains DMS-owned.", - "The tracked-change key schemas contain only identity-key fields and are not shaped as readable or writable resource representations.", - "Generated resource paths make `/deletes` and `/keyChanges` clearly owned by their parent resource path so DMS can preserve them for readable profile resources.", - "The standalone `changeQueries` base document is emitted only as an unprofiled core document and is not duplicated through resource or descriptor fragments.", - "MetaEd unit or integration tests document the expected fragment shape that DMS profile filtering consumes." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", - "Review generated tracked-change component names for at least one core resource and one extension resource.", - "Review generated fragments and confirm `/deletes` and `/keyChanges` paths share the owning resource path prefix." - ], - "completed": true - }, - { - "category": "tests", - "description": "Add focused unit and integration coverage for the Change Query OpenAPI surface in `metaed-plugin-edfi-api-schema`.", - "acceptance-criteria": [ - "Unit tests cover standalone `changeQueries` base document creation, core-only emission, and the `/availableChangeVersions` response shape.", - "Unit tests cover `/deletes` and `/keyChanges` path generation for a regular resource, descriptor, concrete abstract resource, `SchoolYearType`, extension-defined top-level resource, and resource-extension overlay exclusion.", - "Unit tests cover required query parameters on tracked-change paths and live GET-many change-version parameters.", - "Unit tests assert that tracked-change paths do not include cursor-paging parameters or live resource query-field filters.", - "Unit tests cover regular-resource key schema derivation from identity metadata and descriptor key schema derivation from `namespace` and `codeValue`.", - "Tests assert that snapshot-specific OpenAPI artifacts are absent from generated DMS OpenAPI output.", - "Tests use inline snapshots where they verify full generated OpenAPI objects." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts` from the repository root.", - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", - "Run any new focused test file added for Change Query OpenAPI helpers with `npx jest path/to/test.ts` from the repository root." - ], - "completed": true - }, - { - "category": "authoritative-artifacts", - "description": "Update the generated and authoritative ApiSchema integration artifacts to reflect the new Change Query OpenAPI contract.", - "acceptance-criteria": [ - "Core data-standard artifacts include `projectSchema.openApiBaseDocuments.changeQueries` with `/availableChangeVersions`.", - "Core data-standard artifacts include `/deletes` and `/keyChanges` fragments for regular resources, concrete abstract resources, descriptors, and `SchoolYearType`.", - "Extension artifacts include `/deletes` and `/keyChanges` fragments for extension-defined top-level resources and descriptors.", - "Extension artifacts do not include `projectSchema.openApiBaseDocuments.changeQueries`.", - "Updated artifacts contain strongly typed tracked-change response schemas and do not contain snapshot-only OpenAPI artifacts in DMS OpenAPI sections.", - "Updated artifacts preserve `apiSchemaVersion` and show only OpenAPI metadata changes expected by this story.", - "Authoritative compare tests pass for every supported API Schema integration suite whose output changes." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_1.test.ts` from the repository root if v7.1 artifacts change.", - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_2.test.ts` from the repository root if v7.2 artifacts change.", - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/integration/ApiSchemaAuthoritativeCompare_v7_3.test.ts` from the repository root.", - "Run `npx ts-node packages/metaed-plugin-edfi-api-schema/test/integration/update-authoritative-files.ts --dry-run` from the repository root to confirm the generated-to-authoritative copy set before updating authoritative files.", - "Review `git diff -- packages/metaed-plugin-edfi-api-schema/test/integration/artifact` before accepting the updates." - ], - "completed": true - }, - { - "category": "validation", - "description": "Validate the completed MetaEd OpenAPI output and package quality without running the repository publishing build.", - "acceptance-criteria": [ - "Merged resource, descriptor, and Change-Queries OpenAPI documents have no dangling `$ref` values introduced by the new tracked-change schemas or paths.", - "The `metaed-plugin-edfi-api-schema` package type check passes.", - "Directory-level ESLint passes for the package source and tests touched by the implementation.", - "No `npm run build` command is used.", - "The final implementation notes identify any generated artifact diffs that are expected because of the Change Query OpenAPI contract." - ], - "steps-to-verify": [ - "Run `npx tsc -p packages/metaed-plugin-edfi-api-schema --noEmit` from the repository root.", - "Run `npx eslint --max-warnings 0 --ext .js,.ts packages/metaed-plugin-edfi-api-schema/src packages/metaed-plugin-edfi-api-schema/test` from the repository root.", - "Run the focused Jest tests for the changed package with `npx jest path/to/test.ts` from the repository root.", - "Optionally validate merged OpenAPI documents with `@apidevtools/swagger-parser` if new full-document validation coverage is added." - ], - "completed": true - }, - { - "category": "openapi-generation", - "description": "Low: Keep tracked-change path emission and tracked-change schema emission consistent for every concrete Change Query resource.", - "acceptance-criteria": [ - "`createPathsFrom` does not emit `/deletes` or `/keyChanges` operations that reference tracked-change item schemas unless those schemas are emitted for the same fragment.", - "The implementation removes the silent concrete-resource path where `createTrackedChangeSchemasFrom` returns no schemas while tracked-change paths are still generated.", - "If a concrete generated resource cannot derive a public identity-key schema from semantic metadata, the output remains internally consistent and the case is covered by a focused test.", - "Generated core and extension OpenAPI fragments contain no dangling tracked-change `$ref` values." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts` from the repository root.", - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", - "Review generated OpenAPI fragments or the merged-document validation test output and confirm `/deletes` and `/keyChanges` response refs always resolve to emitted tracked-change schemas." - ], - "completed": true - }, - { - "category": "refactoring", - "description": "Low: Consolidate duplicated property-to-OpenAPI schema mapping used by tracked-change key schemas and standard OpenAPI query/resource schema generation.", - "acceptance-criteria": [ - "The scalar `EntityProperty` to OpenAPI `SchemaObject` mapping used by tracked-change key schema generation is shared with the existing OpenAPI generation path instead of being reimplemented in `OpenApiChangeQuerySchemaBuilder`.", - "The shared mapping preserves current generated output for descriptor URI strings, integers including `int64`, dates, date-times, strings with length constraints, booleans, decimals, school years, and years.", - "Tracked-change key schemas continue to derive field names from `queryFieldMapping` and do not introduce string parsing of resource names, component names, or JSONPath segments.", - "Focused tests cover at least one tracked-change identity field for each scalar category whose mapping is shared." - ], - "steps-to-verify": [ - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts` from the repository root.", - "Run `npx jest packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts` from the repository root.", - "Run `npx tsc -p packages/metaed-plugin-edfi-api-schema --noEmit` from the repository root." - ], - "completed": true - }, - { - "category": "repo-hygiene", - "description": "Low: Remove the root progress log artifact from the branch before merge.", - "acceptance-criteria": [ - "`progress.txt` is not committed as a root repository artifact unless the team intentionally documents and references it as part of the repository workflow.", - "Implementation progress history needed for this story remains represented by `tasks.json` or reviewed commit history rather than a standalone root log file.", - "The branch diff contains no unrelated process-log file changes outside the requested MetaEd implementation and task tracking." - ], - "steps-to-verify": [ - "Run `git ls-files progress.txt` from the repository root and confirm it returns no tracked file, or review the documented reason if the file is intentionally retained.", - "Run `git diff --name-status origin/main...HEAD -- progress.txt tasks.json` and confirm only intentional task-tracking changes remain.", - "Review the final branch diff for root-level process artifacts unrelated to the MetaEd OpenAPI implementation." - ], - "completed": true - } -] From b86976a48c47e4bce439ffc78ef660a72df9a369 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 16:34:06 -0500 Subject: [PATCH 18/28] import-fix --- package-lock.json | 6 +++--- packages/metaed-plugin-edfi-api-schema/package.json | 3 ++- 2 files changed, 5 insertions(+), 4 deletions(-) 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", From bd94539c0bb13cd4c92cfe16acb5a75895ab88e1 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 16:55:11 -0500 Subject: [PATCH 19/28] bug-fix --- .../OpenApiChangeQuerySchemaBuilder.ts | 42 +++++++++++++++++-- .../OpenApiResourceFragmentEnhancer.ts | 4 +- .../OpenApiSpecificationEnhancerBase.ts | 35 ++++------------ .../OpenApiChangeQuerySchemaBuilder.test.ts | 18 ++++++-- .../OpenApiResourceFragmentEnhancer.test.ts | 15 ++----- 5 files changed, 67 insertions(+), 47 deletions(-) diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts index 964ac4eea..32415f266 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts @@ -38,6 +38,13 @@ type QueryFieldPathInfoMatch = { pathInfo: QueryFieldPathInfo; }; +/** + * 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. */ @@ -124,6 +131,29 @@ function queryFieldPathInfoMatching( return { fieldName, pathInfo: matchingPathInfo }; } +/** + * Asserts that a concrete resource has complete semantic metadata for tracked-change key schemas. + */ +function assertCanCreateIdentityFieldSchemasFrom( + entity: TopLevelEntity, + identityJsonPaths: JsonPath[], + missingIdentityJsonPaths: JsonPath[], +): void { + if (identityJsonPaths.length === 0) { + throw new Error( + `Unable to create tracked-change key schema for ${entityDisplayNameFor(entity)}. No identity JSON paths were found.`, + ); + } + + if (missingIdentityJsonPaths.length > 0) { + throw new Error( + `Unable to create tracked-change key schema for ${entityDisplayNameFor( + entity, + )}. Missing public query field mapping for identity JSON path(s): ${missingIdentityJsonPaths.join(', ')}.`, + ); + } +} + /** * Creates public identity field schemas for a regular resource from identity and query-field metadata. */ @@ -131,6 +161,7 @@ function identityFieldSchemasFrom(entity: TopLevelEntity): IdentityFieldSchema[] const entityApiSchemaData: EntityApiSchemaData = entity.data.edfiApiSchema as EntityApiSchemaData; const identityJsonPaths: JsonPath[] = entityApiSchemaData.identityJsonPaths ?? []; const includedFieldNames: Set = new Set(); + const missingIdentityJsonPaths: JsonPath[] = []; const result: IdentityFieldSchema[] = []; identityJsonPaths.forEach((identityJsonPath: JsonPath) => { @@ -138,7 +169,12 @@ function identityFieldSchemasFrom(entity: TopLevelEntity): IdentityFieldSchema[] identityJsonPath, entityApiSchemaData.queryFieldMapping, ); - if (match == null || includedFieldNames.has(match.fieldName)) return; + if (match == null) { + missingIdentityJsonPaths.push(identityJsonPath); + return; + } + + if (includedFieldNames.has(match.fieldName)) return; includedFieldNames.add(match.fieldName); result.push({ @@ -147,6 +183,8 @@ function identityFieldSchemasFrom(entity: TopLevelEntity): IdentityFieldSchema[] }); }); + assertCanCreateIdentityFieldSchemasFrom(entity, identityJsonPaths, missingIdentityJsonPaths); + return result; } @@ -250,8 +288,6 @@ export function createTrackedChangeSchemasFrom(entity: TopLevelEntity): Schemas const keyValuesSchema: SchemaObject = entity.type === 'descriptor' ? descriptorKeyValuesSchema() : keyValuesSchemaFrom(identityFieldSchemasFrom(entity)); - if (keyValuesSchema.required == null || keyValuesSchema.required.length === 0) return {}; - return { [trackedChangeSchemaNames.keyValues]: keyValuesSchema, [trackedChangeSchemaNames.deleteItem]: deleteItemSchema(trackedChangeSchemaNames.keyValues), 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 1e339f191..4a5cdd2b6 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts @@ -39,7 +39,7 @@ export function createResourceFragment(entity: TopLevelEntity): OpenApiFragment return { ...fragment, - paths: createPathsFrom(entity, trackedChangeSchemas), + paths: createPathsFrom(entity), tags: createTagsFrom(entity), }; } @@ -51,7 +51,7 @@ function createDescriptorFragment(entity: TopLevelEntity): OpenApiFragment { const trackedChangeSchemas: Schemas = createTrackedChangeSchemasFrom(entity); return { - paths: createPathsFrom(entity, trackedChangeSchemas), + paths: createPathsFrom(entity), components: { schemas: { ...createSchemasFrom(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 680031b96..b3285af41 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts @@ -750,24 +750,10 @@ export function createSchemasFrom(entity: TopLevelEntity): Schemas { return schemas; } -/** - * Returns whether the tracked-change schemas needed by tracked-change paths are present. - */ -function hasTrackedChangePathSchemas( - trackedChangeSchemas: Schemas, - trackedChangeSchemaNames: TrackedChangeSchemaNames, -): boolean { - return ( - trackedChangeSchemas[trackedChangeSchemaNames.keyValues] != null && - trackedChangeSchemas[trackedChangeSchemaNames.deleteItem] != null && - trackedChangeSchemas[trackedChangeSchemaNames.keyChangeItem] != null - ); -} - /** * Creates the paths from a given TopLevelEntity */ -export function createPathsFrom(entity: TopLevelEntity, trackedChangeSchemas: Schemas): PathsObject { +export function createPathsFrom(entity: TopLevelEntity): PathsObject { const paths: PathsObject = {}; const projectEndpointName: ProjectEndpointName = createUriSegment(entity.namespace.projectName) as ProjectEndpointName; @@ -781,18 +767,15 @@ export function createPathsFrom(entity: TopLevelEntity, trackedChangeSchemas: Sc 'x-Ed-Fi-domains': domains, }; - const trackedChangeSchemaNames: TrackedChangeSchemaNames = trackedChangeSchemaNamesFor(entity); - if (hasTrackedChangePathSchemas(trackedChangeSchemas, trackedChangeSchemaNames)) { - paths[`${resourcePath}/deletes`] = { - get: createTrackedChangeDeletesSectionFor(entity, endpointName), - 'x-Ed-Fi-domains': domains, - }; + 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}/keyChanges`] = { + get: createTrackedChangeKeyChangesSectionFor(entity, endpointName), + 'x-Ed-Fi-domains': domains, + }; paths[`${resourcePath}/{id}`] = { get: createGetByIdSectionFor(entity, endpointName), 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 index 6f7bc4bc2..4d94bf68c 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts @@ -422,11 +422,21 @@ describe('OpenApiChangeQuerySchemaBuilder', () => { }); }); - describe('when creating schemas for a concrete resource without public identity field metadata', () => { - const entity: TopLevelEntity = topLevelEntityWith('domainEntity', 'Student', false, {}); + describe('when creating schemas for a concrete resource without complete public identity field metadata', () => { + const entity: TopLevelEntity = topLevelEntityWith('domainEntity', 'Student', false, { + studentUniqueId: [ + { + path: '$.studentReference.studentUniqueId' as JsonPath, + type: 'string', + sourceProperty: stringSourceProperty(), + }, + ], + }); - it('should not create tracked-change schemas', () => { - expect(createTrackedChangeSchemasFrom(entity)).toMatchInlineSnapshot(`Object {}`); + it('should fail rather than create partial tracked-change schemas', () => { + expect(() => createTrackedChangeSchemasFrom(entity)).toThrow( + 'Unable to create tracked-change key schema for EdFi.Student. Missing public query field mapping for identity JSON path(s): $.entryGradeLevelDescriptor, $.schoolReference.schoolId.', + ); }); }); 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 a1452b1e4..0cc539dc1 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 @@ -400,19 +400,10 @@ describe('OpenApiResourceFragmentEnhancer', () => { }); describe('when creating a resource fragment without public tracked-change key metadata', () => { - const fragment: OpenApiFragment = createResourceFragment(concreteResourceWithoutPublicTrackedChangeKeyMetadata()); - - it('should omit tracked-change paths that would reference missing schemas', () => { - const trackedChangeSchemaNames: string[] = Object.keys(fragment.components.schemas).filter((schemaName: string) => - schemaName.includes('_TrackedChange'), + it('should fail rather than omit tracked-change paths', () => { + expect(() => createResourceFragment(concreteResourceWithoutPublicTrackedChangeKeyMetadata())).toThrow( + 'Unable to create tracked-change key schema for EdFi.Student. Missing public query field mapping for identity JSON path(s): $.studentUniqueId.', ); - - expect(fragment.paths?.['/ed-fi/students']).toBeDefined(); - expect(fragment.paths?.['/ed-fi/students/{id}']).toBeDefined(); - expect(fragment.paths?.['/ed-fi/students/deletes']).toBeUndefined(); - expect(fragment.paths?.['/ed-fi/students/keyChanges']).toBeUndefined(); - expect(trackedChangeSchemaNames).toEqual([]); - expect(JSON.stringify(fragment)).not.toContain('_TrackedChange'); }); }); From 68eb2bc065a754e7d337b0520a0d85f0d04914ab Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 17:27:48 -0500 Subject: [PATCH 20/28] ok --- .../test/enhancer/ApiSchemaBuildingEnhancer.test.ts | 2 ++ 1 file changed, 2 insertions(+) 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 0341cd4ec..ea087bf42 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,6 +50,7 @@ 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'; @@ -80,6 +81,7 @@ function runApiSchemaEnhancers(metaEd: MetaEdEnvironment) { documentPathsMappingEnhancer(metaEd); identityFullnameEnhancer(metaEd); subclassIdentityFullnameEnhancer(metaEd); + queryFieldMappingEnhancer(metaEd); identityJsonPathsEnhancer(metaEd); typeCoercionJsonPathsEnhancer(metaEd); enhance(metaEd); From 8ac461851bab54b6234e9158ac0a3192e587f9b4 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 21:23:03 -0500 Subject: [PATCH 21/28] new-enhancer --- .../src/enhancer/EnhancerList.ts | 2 + .../OpenApiChangeQuerySchemaBuilder.ts | 121 +++---------- .../OpenApiTrackedChangeKeyFieldEnhancer.ts | 99 +++++++++++ .../src/model/EntityApiSchemaData.ts | 7 + .../src/model/TrackedChangeKeyField.ts | 19 ++ .../OpenApiChangeQuerySchemaBuilder.test.ts | 168 +++++------------- .../OpenApiResourceFragmentEnhancer.test.ts | 9 +- ...enApiTrackedChangeKeyFieldEnhancer.test.ts | 134 ++++++++++++++ 8 files changed, 337 insertions(+), 222 deletions(-) create mode 100644 packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts create mode 100644 packages/metaed-plugin-edfi-api-schema/src/model/TrackedChangeKeyField.ts create mode 100644 packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts 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/OpenApiChangeQuerySchemaBuilder.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts index 32415f266..b6b9937d3 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts @@ -5,11 +5,8 @@ import { type DomainEntity, type TopLevelEntity } from '@edfi/metaed-core'; import type { EntityApiSchemaData } from '../model/EntityApiSchemaData'; -import type { JsonPath } from '../model/api-schema/JsonPath'; -import type { PathType } from '../model/api-schema/PathType'; -import type { QueryFieldMapping } from '../model/api-schema/QueryFieldMapping'; -import type { QueryFieldPathInfo } from '../model/api-schema/QueryFieldPathInfo'; import type { SchemaObject, Schemas } from '../model/OpenApiTypes'; +import type { TrackedChangeKeyField } from '../model/TrackedChangeKeyField'; import { deAcronym, normalizeDescriptorName } from '../Utility'; import { schemaObjectFromEntityProperty } from './OpenApiEntityPropertySchemaMapper'; @@ -30,14 +27,6 @@ type IdentityFieldSchema = { schema: SchemaObject; }; -/** - * Query field path information matched to a public query field name. - */ -type QueryFieldPathInfoMatch = { - fieldName: string; - pathInfo: QueryFieldPathInfo; -}; - /** * Creates a display name for tracked-change invariant messages. */ @@ -78,114 +67,44 @@ function isAbstractResource(entity: TopLevelEntity): boolean { ); } -/** - * Creates a fallback schema from API Schema path type metadata. - */ -function schemaObjectFromPathType(pathType: PathType): SchemaObject { - switch (pathType) { - case 'boolean': - return { type: 'boolean' }; - case 'date': - return { type: 'string', format: 'date' }; - case 'date-time': - return { type: 'string', format: 'date-time' }; - case 'number': - return { type: 'number', format: 'double' }; - case 'string': - return { type: 'string' }; - case 'time': - return { type: 'string' }; - default: - return { type: 'string' }; - } -} - -/** - * Creates an OpenAPI schema object from query field path metadata. - */ -function schemaObjectFromQueryFieldPathInfo(pathInfo: QueryFieldPathInfo): SchemaObject { - if (pathInfo.sourceProperty == null) return schemaObjectFromPathType(pathInfo.type); - - return schemaObjectFromEntityProperty(pathInfo.sourceProperty, { type: 'string' }); -} - -/** - * Finds public query field path info by exact identity JSON path match. - */ -function queryFieldPathInfoMatching( - identityJsonPath: JsonPath, - queryFieldMapping: QueryFieldMapping, -): QueryFieldPathInfoMatch | undefined { - const matchingQueryFieldEntry: [string, QueryFieldPathInfo[]] | undefined = Object.entries(queryFieldMapping).find( - ([, pathInfos]: [string, QueryFieldPathInfo[]]) => - pathInfos.some((pathInfo: QueryFieldPathInfo) => pathInfo.path === identityJsonPath), - ); - if (matchingQueryFieldEntry == null) return undefined; - - const [fieldName, pathInfos] = matchingQueryFieldEntry; - const matchingPathInfo: QueryFieldPathInfo | undefined = pathInfos.find( - (pathInfo: QueryFieldPathInfo) => pathInfo.path === identityJsonPath, - ); - if (matchingPathInfo == null) return undefined; - - return { fieldName, pathInfo: matchingPathInfo }; -} - /** * Asserts that a concrete resource has complete semantic metadata for tracked-change key schemas. */ function assertCanCreateIdentityFieldSchemasFrom( entity: TopLevelEntity, - identityJsonPaths: JsonPath[], - missingIdentityJsonPaths: JsonPath[], + trackedChangeKeyFields: TrackedChangeKeyField[], ): void { - if (identityJsonPaths.length === 0) { - throw new Error( - `Unable to create tracked-change key schema for ${entityDisplayNameFor(entity)}. No identity JSON paths were found.`, - ); - } - - if (missingIdentityJsonPaths.length > 0) { + if (trackedChangeKeyFields.length === 0) { throw new Error( `Unable to create tracked-change key schema for ${entityDisplayNameFor( entity, - )}. Missing public query field mapping for identity JSON path(s): ${missingIdentityJsonPaths.join(', ')}.`, + )}. No tracked-change key fields were found.`, ); } } /** - * Creates public identity field schemas for a regular resource from identity and query-field metadata. + * 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 identityJsonPaths: JsonPath[] = entityApiSchemaData.identityJsonPaths ?? []; - const includedFieldNames: Set = new Set(); - const missingIdentityJsonPaths: JsonPath[] = []; - const result: IdentityFieldSchema[] = []; - - identityJsonPaths.forEach((identityJsonPath: JsonPath) => { - const match: QueryFieldPathInfoMatch | undefined = queryFieldPathInfoMatching( - identityJsonPath, - entityApiSchemaData.queryFieldMapping, - ); - if (match == null) { - missingIdentityJsonPaths.push(identityJsonPath); - return; - } + const trackedChangeKeyFields: TrackedChangeKeyField[] = entityApiSchemaData.trackedChangeKeyFields ?? []; - if (includedFieldNames.has(match.fieldName)) return; + assertCanCreateIdentityFieldSchemasFrom(entity, trackedChangeKeyFields); - includedFieldNames.add(match.fieldName); - result.push({ - fieldName: match.fieldName, - schema: schemaObjectFromQueryFieldPathInfo(match.pathInfo), - }); - }); - - assertCanCreateIdentityFieldSchemasFrom(entity, identityJsonPaths, missingIdentityJsonPaths); - - return result; + return trackedChangeKeyFields.map((trackedChangeKeyField: TrackedChangeKeyField) => + identityFieldSchemaFrom(trackedChangeKeyField), + ); } /** 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..c9a57f0de --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts @@ -0,0 +1,99 @@ +// 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 type { EntityApiSchemaData } from '../model/EntityApiSchemaData'; +import type { EntityPropertyApiSchemaData } from '../model/EntityPropertyApiSchemaData'; +import type { FlattenedIdentityProperty } from '../model/FlattenedIdentityProperty'; +import { defaultPropertyModifier, prefixedName } from '../model/PropertyModifier'; +import type { TrackedChangeKeyField, TrackedChangeKeyFieldName } from '../model/TrackedChangeKeyField'; +import { findIdenticalRoleNamePatternPrefix, prependPrefixWithCollapse, uncapitalize } from '../Utility'; +import { parentPropertyModifier } from './JsonElementNamingHelper'; + +const enhancerName = 'OpenApiTrackedChangeKeyFieldEnhancer'; + +/** + * 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 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); + trackedChangeKeyFieldsByName[fieldName] = { + fieldName, + sourceProperty: 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/model/EntityApiSchemaData.ts b/packages/metaed-plugin-edfi-api-schema/src/model/EntityApiSchemaData.ts index dd38df929..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. */ @@ -285,6 +291,7 @@ export function addEntityApiSchemaDataTo(entity: ModelBase) { resourceName: '' as MetaEdResourceName, identityFullnames: [], identityJsonPaths: [], + trackedChangeKeyFields: [], queryFieldMapping: {}, namespaceSecurableElements: [], educationOrganizationSecurableElements: [], 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/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts index 4d94bf68c..1cf546589 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts @@ -11,17 +11,13 @@ import { type TopLevelEntity, } from '@edfi/metaed-core'; import { createTrackedChangeSchemasFrom } from '../../src/enhancer/OpenApiChangeQuerySchemaBuilder'; -import type { JsonPath } from '../../src/model/api-schema/JsonPath'; -import type { PathType } from '../../src/model/api-schema/PathType'; -import type { QueryFieldMapping } from '../../src/model/api-schema/QueryFieldMapping'; +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: string; - identityJsonPath: JsonPath; - pathType: PathType; + fieldName: TrackedChangeKeyFieldName; sourceProperty: EntityProperty; }; @@ -90,138 +86,90 @@ function descriptorSourceProperty(): EntityProperty { function scalarIdentitySourcePropertyCases(): ScalarIdentitySourcePropertyCase[] { return [ { - fieldName: 'booleanIdentity', - identityJsonPath: '$.booleanIdentity' as JsonPath, - pathType: 'boolean', + fieldName: 'booleanIdentity' as TrackedChangeKeyFieldName, sourceProperty: sourcePropertyOfType('boolean', 'Boolean identity field'), }, { - fieldName: 'dateIdentity', - identityJsonPath: '$.dateIdentity' as JsonPath, - pathType: 'date', + fieldName: 'dateIdentity' as TrackedChangeKeyFieldName, sourceProperty: sourcePropertyOfType('date', 'Date identity field'), }, { - fieldName: 'dateTimeIdentity', - identityJsonPath: '$.dateTimeIdentity' as JsonPath, - pathType: 'date-time', + fieldName: 'dateTimeIdentity' as TrackedChangeKeyFieldName, sourceProperty: sourcePropertyOfType('datetime', 'Date-time identity field'), }, { - fieldName: 'decimalIdentity', - identityJsonPath: '$.decimalIdentity' as JsonPath, - pathType: 'number', + fieldName: 'decimalIdentity' as TrackedChangeKeyFieldName, sourceProperty: sourcePropertyOfType('decimal', 'Decimal identity field'), }, { - fieldName: 'descriptorIdentity', - identityJsonPath: '$.descriptorIdentity' as JsonPath, - pathType: 'string', + fieldName: 'descriptorIdentity' as TrackedChangeKeyFieldName, sourceProperty: descriptorSourceProperty(), }, { - fieldName: 'durationIdentity', - identityJsonPath: '$.durationIdentity' as JsonPath, - pathType: 'string', + fieldName: 'durationIdentity' as TrackedChangeKeyFieldName, sourceProperty: sourcePropertyOfType('duration', 'Duration identity field'), }, { - fieldName: 'int64Identity', - identityJsonPath: '$.int64Identity' as JsonPath, - pathType: 'number', + fieldName: 'int64Identity' as TrackedChangeKeyFieldName, sourceProperty: bigIntegerSourceProperty(), }, { - fieldName: 'schoolYearIdentity', - identityJsonPath: '$.schoolYearIdentity' as JsonPath, - pathType: 'number', + fieldName: 'schoolYearIdentity' as TrackedChangeKeyFieldName, sourceProperty: sourcePropertyOfType('schoolYearEnumeration', 'School year identity field'), }, { - fieldName: 'stringIdentity', - identityJsonPath: '$.stringIdentity' as JsonPath, - pathType: 'string', + fieldName: 'stringIdentity' as TrackedChangeKeyFieldName, sourceProperty: stringSourceProperty(), }, { - fieldName: 'timeIdentity', - identityJsonPath: '$.timeIdentity' as JsonPath, - pathType: 'time', + fieldName: 'timeIdentity' as TrackedChangeKeyFieldName, sourceProperty: sourcePropertyOfType('time', 'Time identity field'), }, { - fieldName: 'yearIdentity', - identityJsonPath: '$.yearIdentity' as JsonPath, - pathType: 'number', + fieldName: 'yearIdentity' as TrackedChangeKeyFieldName, sourceProperty: sourcePropertyOfType('year', 'Year identity field'), }, ]; } /** - * Creates query field mapping metadata from scalar source property cases. + * Creates tracked-change key field metadata from scalar source property cases. */ -function queryFieldMappingFrom(sourcePropertyCases: ScalarIdentitySourcePropertyCase[]): QueryFieldMapping { - const result: QueryFieldMapping = {}; - - sourcePropertyCases.forEach((sourcePropertyCase: ScalarIdentitySourcePropertyCase) => { - result[sourcePropertyCase.fieldName] = [ - { - path: sourcePropertyCase.identityJsonPath, - type: sourcePropertyCase.pathType, - sourceProperty: sourcePropertyCase.sourceProperty, - }, - ]; - }); - - return result; +function trackedChangeKeyFieldsFrom(sourcePropertyCases: ScalarIdentitySourcePropertyCase[]): TrackedChangeKeyField[] { + return sourcePropertyCases.map((sourcePropertyCase: ScalarIdentitySourcePropertyCase) => ({ + fieldName: sourcePropertyCase.fieldName, + sourceProperty: sourcePropertyCase.sourceProperty, + })); } /** - * Creates regular resource query field mapping metadata for tracked-change schema tests. + * Creates regular resource tracked-change key field metadata for tracked-change schema tests. */ -function regularResourceQueryFieldMapping(): QueryFieldMapping { - return { - entryGradeLevelDescriptor: [ - { - path: '$.entryGradeLevelDescriptor' as JsonPath, - type: 'string', - sourceProperty: descriptorSourceProperty(), - }, - ], - internalEntryGradeLevelDescriptorId: [ - { - path: '$.entryGradeLevelDescriptorId' as JsonPath, - type: 'number', - sourceProperty: integerSourceProperty(), - }, - ], - schoolId: [ - { - path: '$.schoolReference.schoolId' as JsonPath, - type: 'number', - sourceProperty: integerSourceProperty(), - }, - ], - studentUniqueId: [ - { - path: '$.studentReference.studentUniqueId' as JsonPath, - type: 'string', - sourceProperty: stringSourceProperty(), - }, - ], - }; +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 identity paths for tracked-change schema generation. + * Creates a top-level entity with explicit tracked-change key fields for tracked-change schema generation. */ -function topLevelEntityWithIdentityJsonPaths( +function topLevelEntityWithTrackedChangeKeyFields( type: string, metaEdName: string, isAbstract: boolean, - identityJsonPaths: JsonPath[], - queryFieldMapping: QueryFieldMapping, + trackedChangeKeyFields: TrackedChangeKeyField[], ): TopLevelEntity { return { type, @@ -232,8 +180,7 @@ function topLevelEntityWithIdentityJsonPaths( }, data: { edfiApiSchema: { - identityJsonPaths, - queryFieldMapping, + trackedChangeKeyFields, }, }, } as unknown as TopLevelEntity; @@ -246,19 +193,9 @@ function topLevelEntityWith( type: string, metaEdName: string, isAbstract: boolean, - queryFieldMapping: QueryFieldMapping, + trackedChangeKeyFields: TrackedChangeKeyField[], ): TopLevelEntity { - return topLevelEntityWithIdentityJsonPaths( - type, - metaEdName, - isAbstract, - [ - '$.entryGradeLevelDescriptor' as JsonPath, - '$.schoolReference.schoolId' as JsonPath, - '$.studentReference.studentUniqueId' as JsonPath, - ], - queryFieldMapping, - ); + return topLevelEntityWithTrackedChangeKeyFields(type, metaEdName, isAbstract, trackedChangeKeyFields); } describe('OpenApiChangeQuerySchemaBuilder', () => { @@ -267,7 +204,7 @@ describe('OpenApiChangeQuerySchemaBuilder', () => { 'association', 'StudentSchoolAssociation', false, - regularResourceQueryFieldMapping(), + regularResourceTrackedChangeKeyFields(), ); it('should create tracked-change schemas from public identity query fields', () => { @@ -347,12 +284,11 @@ describe('OpenApiChangeQuerySchemaBuilder', () => { describe('when creating key schemas from scalar identity source properties', () => { const sourcePropertyCases: ScalarIdentitySourcePropertyCase[] = scalarIdentitySourcePropertyCases(); - const entity: TopLevelEntity = topLevelEntityWithIdentityJsonPaths( + const entity: TopLevelEntity = topLevelEntityWithTrackedChangeKeyFields( 'domainEntity', 'ScalarIdentityResource', false, - sourcePropertyCases.map((sourcePropertyCase: ScalarIdentitySourcePropertyCase) => sourcePropertyCase.identityJsonPath), - queryFieldMappingFrom(sourcePropertyCases), + trackedChangeKeyFieldsFrom(sourcePropertyCases), ); it('should use the standard OpenAPI schema mapping for tracked-change identity fields', () => { @@ -423,19 +359,11 @@ describe('OpenApiChangeQuerySchemaBuilder', () => { }); describe('when creating schemas for a concrete resource without complete public identity field metadata', () => { - const entity: TopLevelEntity = topLevelEntityWith('domainEntity', 'Student', false, { - studentUniqueId: [ - { - path: '$.studentReference.studentUniqueId' as JsonPath, - type: 'string', - sourceProperty: stringSourceProperty(), - }, - ], - }); + 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. Missing public query field mapping for identity JSON path(s): $.entryGradeLevelDescriptor, $.schoolReference.schoolId.', + 'Unable to create tracked-change key schema for EdFi.Student. No tracked-change key fields were found.', ); }); }); @@ -526,7 +454,7 @@ describe('OpenApiChangeQuerySchemaBuilder', () => { 'domainEntitySubclass', 'School', false, - regularResourceQueryFieldMapping(), + regularResourceTrackedChangeKeyFields(), ); it('should create tracked-change schemas for the concrete resource', () => { @@ -545,7 +473,7 @@ describe('OpenApiChangeQuerySchemaBuilder', () => { 'domainEntity', 'EducationOrganization', true, - regularResourceQueryFieldMapping(), + regularResourceTrackedChangeKeyFields(), ); it('should not create tracked-change schemas', () => { 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 0cc539dc1..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 @@ -27,11 +27,14 @@ import { enhance as entityApiSchemaDataSetupEnhancer } from '../../src/model/Ent 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'; @@ -157,6 +160,9 @@ function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment) { apiPropertyMappingEnhancer(metaEd); propertyCollectingEnhancer(metaEd); apiEntityMappingEnhancer(metaEd); + subclassApiEntityMappingEnhancer(metaEd); + mergeCoveringFlattenedIdentityPropertyEnhancer(metaEd); + openApiTrackedChangeKeyFieldEnhancer(metaEd); jsonSchemaForInsertEnhancer(metaEd); allJsonPathsMappingEnhancer(metaEd); mergeJsonPathsMappingEnhancer(metaEd); @@ -192,6 +198,7 @@ function concreteResourceWithoutPublicTrackedChangeKeyMetadata(): TopLevelEntity endpointName: 'students', domains: [], identityJsonPaths: ['$.studentUniqueId' as JsonPath], + trackedChangeKeyFields: [], queryFieldMapping: {}, openApiReferenceComponent: {}, openApiReferenceComponentPropertyName: '', @@ -402,7 +409,7 @@ 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. Missing public query field mapping for identity JSON path(s): $.studentUniqueId.', + 'Unable to create tracked-change key schema for EdFi.Student. No tracked-change key fields were found.', ); }); }); 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..aca1af766 --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts @@ -0,0 +1,134 @@ +// 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 { + DomainEntityBuilder, + MetaEdEnvironment, + MetaEdTextBuilder, + Namespace, + NamespaceBuilder, + TopLevelEntity, + newMetaEdEnvironment, +} 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 referenceComponentEnhancer } from '../../src/enhancer/ReferenceComponentEnhancer'; +import { enhance as apiPropertyMappingEnhancer } from '../../src/enhancer/ApiPropertyMappingEnhancer'; +import { enhance as propertyCollectingEnhancer } from '../../src/enhancer/PropertyCollectingEnhancer'; +import { enhance as apiEntityMappingEnhancer } from '../../src/enhancer/ApiEntityMappingEnhancer'; +import { enhance as mergeCoveringFlattenedIdentityPropertyEnhancer } from '../../src/enhancer/MergeCoveringFlattenedIdentityPropertyEnhancer'; +import { enhance } from '../../src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer'; +import { createTrackedChangeSchemasFrom } from '../../src/enhancer/OpenApiChangeQuerySchemaBuilder'; +import type { EntityApiSchemaData } from '../../src/model/EntityApiSchemaData'; +import type { TrackedChangeKeyField } from '../../src/model/TrackedChangeKeyField'; + +/** + * 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); +} + +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); + enhance(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", + } + `); + }); + }); +}); From 9683d2a4cc6f00526c48d3c92a6251c373e0f2cc Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 21:43:11 -0500 Subject: [PATCH 22/28] clarification --- .../enhancer/OpenApiBaseDocumentEnhancer.ts | 2 +- .../ApiSchemaBuildingEnhancer.test.ts | 4 +- .../OpenApiBaseDocumentEnhancer.test.ts | 2 +- ...OpenApiGeneratedDocumentValidation.test.ts | 76 ++++++++++++++++++- 4 files changed, 78 insertions(+), 6 deletions(-) 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 0b81a8d5c..85fb446d9 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts @@ -122,7 +122,7 @@ 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 = { [OpenApiDocumentType.RESOURCES]: createBaseOpenApiDocument(metaEd, OpenApiDocumentType.RESOURCES), [OpenApiDocumentType.DESCRIPTORS]: createBaseOpenApiDocument(metaEd, OpenApiDocumentType.DESCRIPTORS), 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 ea087bf42..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 @@ -55,6 +55,7 @@ import { enhance as identityJsonPathsEnhancer } from '../../src/enhancer/Identit 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'; @@ -84,6 +85,7 @@ function runApiSchemaEnhancers(metaEd: MetaEdEnvironment) { queryFieldMappingEnhancer(metaEd); identityJsonPathsEnhancer(metaEd); typeCoercionJsonPathsEnhancer(metaEd); + openApiTrackedChangeKeyFieldEnhancer(metaEd); enhance(metaEd); } @@ -3595,7 +3597,7 @@ describe('when building ApiSchema with OpenAPI base documents', () => { enhance(metaEd); }); - it('should copy optional change queries base document into core project schema', () => { + 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(); 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 3d35ee5cb..defc56cb4 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 @@ -87,7 +87,7 @@ describe('OpenApiBaseDocumentEnhancer', () => { expect(descriptorsDoc?.tags).toEqual([]); }); - it('should create base document for change queries', () => { + 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]; 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 index f0d023e9e..939650b01 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts @@ -33,6 +33,9 @@ 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. @@ -392,6 +395,57 @@ async function validateOpenApiDocument(document: Document): Promise { + 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[] = []; @@ -400,7 +454,7 @@ describe('generated OpenAPI documents', (): void => { apiSchemaArtifacts = await generatedApiSchemaArtifactsFor(validationGroup); }); - it('should validate merged resources, descriptors, and change queries documents', async (): Promise => { + 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[] = [ @@ -418,10 +472,26 @@ describe('generated OpenAPI documents', (): void => { 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, - composeOpenApiDocument(descriptorsBaseDocument as Document, projectSchemas, OpenApiDocumentType.DESCRIPTORS), - composeOpenApiDocument(resourcesBaseDocument as Document, projectSchemas, OpenApiDocumentType.RESOURCES), + descriptorsDocument, + resourcesDocument, ]; await Promise.all(documentsToValidate.map(validateOpenApiDocument)); From f5a0201d5991972d78b24ffdba884f429bddea94 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Wed, 10 Jun 2026 23:10:44 -0500 Subject: [PATCH 23/28] tests --- ...enApiTrackedChangeKeyFieldEnhancer.test.ts | 263 +++++++++++++++++- 1 file changed, 260 insertions(+), 3 deletions(-) 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 index aca1af766..ad26fbed1 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts @@ -4,13 +4,16 @@ // 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, @@ -19,15 +22,34 @@ import { } 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 } from '../../src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer'; -import { createTrackedChangeSchemasFrom } from '../../src/enhancer/OpenApiChangeQuerySchemaBuilder'; +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. @@ -45,6 +67,83 @@ function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment): void { 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(); @@ -80,7 +179,7 @@ describe('OpenApiTrackedChangeKeyFieldEnhancer', () => { namespace = metaEd.namespace.get(namespaceName) as Namespace; runPrerequisiteEnhancers(metaEd); - enhance(metaEd); + openApiTrackedChangeKeyFieldEnhancer(metaEd); }); it('should derive public tracked-change key fields from merge-aware identity metadata', () => { @@ -131,4 +230,162 @@ describe('OpenApiTrackedChangeKeyFieldEnhancer', () => { `); }); }); + + 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']); + }); + }); }); From 3e9b27b38675a828f0332e5d50ad725ddd9c0383 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Thu, 11 Jun 2026 00:29:34 -0500 Subject: [PATCH 24/28] sort-requireds --- .../OpenApiChangeQuerySchemaBuilder.ts | 4 +- .../v7_1/ds-5.0-api-schema-authoritative.json | 52 +++--- .../v7_2/ds-5.1-api-schema-authoritative.json | 52 +++--- .../v7_2/tpdm-api-schema-authoritative.json | 32 ++-- .../v7_3/ds-5.2-api-schema-authoritative.json | 60 +++---- .../v7_3/ds-6.0-api-schema-authoritative.json | 138 ++++++++-------- .../v7_3/ds-6.1-api-schema-authoritative.json | 148 +++++++++--------- .../v7_3/tpdm-api-schema-authoritative.json | 32 ++-- 8 files changed, 260 insertions(+), 258 deletions(-) diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts index b6b9937d3..82e7f6fbe 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts @@ -139,9 +139,11 @@ function keyValuesSchemaFrom(identityFieldSchemas: IdentityFieldSchema[]): Schem required.push(identityFieldSchema.fieldName); }); + const sortedRequired: string[] = [...required].sort(); + return { type: 'object', - required, + required: sortedRequired, properties, }; } 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 df2018e73..e0fa6878d 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 @@ -14920,8 +14920,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -25903,9 +25903,9 @@ }, "required": [ "calendarCode", + "date", "schoolId", - "schoolYear", - "date" + "schoolYear" ], "type": "object" }, @@ -103682,11 +103682,11 @@ } }, "required": [ + "beginDate", "gradeTypeDescriptor", "gradingPeriodDescriptor", "gradingPeriodName", "gradingPeriodSchoolYear", - "beginDate", "localCourseCode", "schoolId", "schoolYear", @@ -135387,8 +135387,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -136230,8 +136230,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -137124,8 +137124,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -141114,8 +141114,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -142008,8 +142008,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -152267,8 +152267,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -174549,8 +174549,8 @@ } }, "required": [ - "programEvaluationElementTitle", "programEducationOrganizationId", + "programEvaluationElementTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -175700,8 +175700,8 @@ } }, "required": [ - "programEvaluationObjectiveTitle", "programEducationOrganizationId", + "programEvaluationObjectiveTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -178282,10 +178282,10 @@ } }, "required": [ + "programEducationOrganizationId", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", - "programEducationOrganizationId", "programName", "programTypeDescriptor" ], @@ -210835,8 +210835,8 @@ "localCourseCode", "schoolId", "schoolYear", - "sessionName", - "sectionIdentifier" + "sectionIdentifier", + "sessionName" ], "type": "object" }, @@ -240765,9 +240765,9 @@ } }, "required": [ + "assessmentIdentifier", "educationOrganizationAssociationTypeDescriptor", "educationOrganizationId", - "assessmentIdentifier", "namespace", "studentAssessmentIdentifier", "studentUniqueId" @@ -247316,8 +247316,8 @@ "gradingPeriodName", "gradingPeriodSchoolId", "gradingPeriodSchoolYear", - "objectiveEducationOrganizationId", "objective", + "objectiveEducationOrganizationId", "objectiveGradeLevelDescriptor", "studentUniqueId" ], @@ -258991,8 +258991,8 @@ }, "required": [ "attendanceEventCategoryDescriptor", - "eventDate", "educationOrganizationId", + "eventDate", "interventionIdentificationCode", "studentUniqueId" ], @@ -286040,9 +286040,9 @@ }, "required": [ "educationOrganizationId", + "namespace", "programName", "programTypeDescriptor", - "namespace", "surveyIdentifier" ], "type": "object" @@ -288254,8 +288254,8 @@ } }, "required": [ - "questionCode", "namespace", + "questionCode", "surveyIdentifier" ], "type": "object" @@ -289861,8 +289861,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -291831,11 +291831,11 @@ }, "required": [ "localCourseCode", + "namespace", "schoolId", "schoolYear", "sectionIdentifier", "sessionName", - "namespace", "surveyIdentifier" ], "type": "object" @@ -293554,8 +293554,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" @@ -294420,9 +294420,9 @@ } }, "required": [ - "surveyResponseIdentifier", "namespace", "surveyIdentifier", + "surveyResponseIdentifier", "surveySectionTitle" ], "type": "object" 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 b1b044498..f0d5e3436 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 @@ -14892,8 +14892,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -26524,9 +26524,9 @@ }, "required": [ "calendarCode", + "date", "schoolId", - "schoolYear", - "date" + "schoolYear" ], "type": "object" }, @@ -105992,11 +105992,11 @@ } }, "required": [ + "beginDate", "gradeTypeDescriptor", "gradingPeriodDescriptor", "gradingPeriodName", "gradingPeriodSchoolYear", - "beginDate", "localCourseCode", "schoolId", "schoolYear", @@ -138329,8 +138329,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -139168,8 +139168,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -140055,8 +140055,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -143998,8 +143998,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -144885,8 +144885,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -155836,8 +155836,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -177992,8 +177992,8 @@ } }, "required": [ - "programEvaluationElementTitle", "programEducationOrganizationId", + "programEvaluationElementTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -179139,8 +179139,8 @@ } }, "required": [ - "programEvaluationObjectiveTitle", "programEducationOrganizationId", + "programEvaluationObjectiveTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -181717,10 +181717,10 @@ } }, "required": [ + "programEducationOrganizationId", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", - "programEducationOrganizationId", "programName", "programTypeDescriptor" ], @@ -214151,8 +214151,8 @@ "localCourseCode", "schoolId", "schoolYear", - "sessionName", - "sectionIdentifier" + "sectionIdentifier", + "sessionName" ], "type": "object" }, @@ -243767,9 +243767,9 @@ } }, "required": [ + "assessmentIdentifier", "educationOrganizationAssociationTypeDescriptor", "educationOrganizationId", - "assessmentIdentifier", "namespace", "studentAssessmentIdentifier", "studentUniqueId" @@ -250239,8 +250239,8 @@ "gradingPeriodName", "gradingPeriodSchoolId", "gradingPeriodSchoolYear", - "objectiveEducationOrganizationId", "objective", + "objectiveEducationOrganizationId", "objectiveGradeLevelDescriptor", "studentUniqueId" ], @@ -262971,8 +262971,8 @@ }, "required": [ "attendanceEventCategoryDescriptor", - "eventDate", "educationOrganizationId", + "eventDate", "interventionIdentificationCode", "studentUniqueId" ], @@ -290777,9 +290777,9 @@ }, "required": [ "educationOrganizationId", + "namespace", "programName", "programTypeDescriptor", - "namespace", "surveyIdentifier" ], "type": "object" @@ -292952,8 +292952,8 @@ } }, "required": [ - "questionCode", "namespace", + "questionCode", "surveyIdentifier" ], "type": "object" @@ -294538,8 +294538,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -296475,11 +296475,11 @@ }, "required": [ "localCourseCode", + "namespace", "schoolId", "schoolYear", "sectionIdentifier", "sessionName", - "namespace", "surveyIdentifier" ], "type": "object" @@ -298170,8 +298170,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" @@ -299022,9 +299022,9 @@ } }, "required": [ - "surveyResponseIdentifier", "namespace", "surveyIdentifier", + "surveyResponseIdentifier", "surveySectionTitle" ], "type": "object" 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 eb48dd28c..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 @@ -12738,9 +12738,9 @@ } }, "required": [ - "evaluationElementTitle", "educationOrganizationId", "evaluationDate", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", @@ -14049,8 +14049,8 @@ } }, "required": [ - "evaluationElementTitle", "educationOrganizationId", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", @@ -15450,11 +15450,11 @@ } }, "required": [ - "evaluationObjectiveTitle", - "evaluationTitle", "educationOrganizationId", "evaluationDate", + "evaluationObjectiveTitle", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "personId", @@ -16686,8 +16686,8 @@ } }, "required": [ - "evaluationObjectiveTitle", "educationOrganizationId", + "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", "performanceEvaluationTitle", @@ -20525,12 +20525,12 @@ } }, "required": [ - "evaluationDate", - "evaluationTitle", - "performanceEvaluationTypeDescriptor", "educationOrganizationId", + "evaluationDate", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", "personId", "schoolYear", "sourceSystemDescriptor", @@ -22543,9 +22543,9 @@ } }, "required": [ - "evaluationTitle", "educationOrganizationId", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "schoolYear", @@ -27056,10 +27056,10 @@ "evaluationPeriodDescriptor", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", - "schoolYear", - "termDescriptor", "personId", - "sourceSystemDescriptor" + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" ], "type": "object" }, @@ -30109,9 +30109,9 @@ "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", + "rubricRating", "schoolYear", - "termDescriptor", - "rubricRating" + "termDescriptor" ], "type": "object" }, @@ -31914,9 +31914,9 @@ } }, "required": [ + "namespace", "personId", "sourceSystemDescriptor", - "namespace", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -32896,9 +32896,9 @@ } }, "required": [ + "namespace", "personId", "sourceSystemDescriptor", - "namespace", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" 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 31ee55ffa..2cb61c31c 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 @@ -12897,8 +12897,8 @@ "required": [ "administrationIdentifier", "assessmentIdentifier", - "namespace", - "assigningEducationOrganizationId" + "assigningEducationOrganizationId", + "namespace" ], "type": "object" }, @@ -17661,8 +17661,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -29298,9 +29298,9 @@ }, "required": [ "calendarCode", + "date", "schoolId", - "schoolYear", - "date" + "schoolYear" ], "type": "object" }, @@ -110252,11 +110252,11 @@ } }, "required": [ + "beginDate", "gradeTypeDescriptor", "gradingPeriodDescriptor", "gradingPeriodName", "gradingPeriodSchoolYear", - "beginDate", "localCourseCode", "schoolId", "schoolYear", @@ -142594,8 +142594,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -143433,8 +143433,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -144320,8 +144320,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -148263,8 +148263,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -149150,8 +149150,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -160101,8 +160101,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -182262,8 +182262,8 @@ } }, "required": [ - "programEvaluationElementTitle", "programEducationOrganizationId", + "programEvaluationElementTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -183409,8 +183409,8 @@ } }, "required": [ - "programEvaluationObjectiveTitle", "programEducationOrganizationId", + "programEvaluationObjectiveTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -185987,10 +185987,10 @@ } }, "required": [ + "programEducationOrganizationId", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", - "programEducationOrganizationId", "programName", "programTypeDescriptor" ], @@ -219226,8 +219226,8 @@ "localCourseCode", "schoolId", "schoolYear", - "sessionName", - "sectionIdentifier" + "sectionIdentifier", + "sessionName" ], "type": "object" }, @@ -248867,9 +248867,9 @@ } }, "required": [ + "assessmentIdentifier", "educationOrganizationAssociationTypeDescriptor", "educationOrganizationId", - "assessmentIdentifier", "namespace", "studentAssessmentIdentifier", "studentUniqueId" @@ -249859,8 +249859,8 @@ } }, "required": [ - "assessmentBatteryPartName", "administrationIdentifier", + "assessmentBatteryPartName", "assessmentIdentifier", "assigningEducationOrganizationId", "educationOrganizationId", @@ -251090,8 +251090,8 @@ "administrationIdentifier", "assessmentIdentifier", "assigningEducationOrganizationId", - "namespace", "educationOrganizationId", + "namespace", "studentUniqueId" ], "type": "object" @@ -257686,8 +257686,8 @@ "gradingPeriodName", "gradingPeriodSchoolId", "gradingPeriodSchoolYear", - "objectiveEducationOrganizationId", "objective", + "objectiveEducationOrganizationId", "objectiveGradeLevelDescriptor", "studentUniqueId" ], @@ -271237,8 +271237,8 @@ }, "required": [ "attendanceEventCategoryDescriptor", - "eventDate", "educationOrganizationId", + "eventDate", "interventionIdentificationCode", "studentUniqueId" ], @@ -299909,9 +299909,9 @@ }, "required": [ "educationOrganizationId", + "namespace", "programName", "programTypeDescriptor", - "namespace", "surveyIdentifier" ], "type": "object" @@ -302084,8 +302084,8 @@ } }, "required": [ - "questionCode", "namespace", + "questionCode", "surveyIdentifier" ], "type": "object" @@ -303670,8 +303670,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -305607,11 +305607,11 @@ }, "required": [ "localCourseCode", + "namespace", "schoolId", "schoolYear", "sectionIdentifier", "sessionName", - "namespace", "surveyIdentifier" ], "type": "object" @@ -307302,8 +307302,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" @@ -308154,9 +308154,9 @@ } }, "required": [ - "surveyResponseIdentifier", "namespace", "surveyIdentifier", + "surveyResponseIdentifier", "surveySectionTitle" ], "type": "object" 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 68f74efe9..203ad4a52 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 @@ -18924,8 +18924,8 @@ } }, "required": [ - "applicationEventTypeDescriptor", "applicantProfileIdentifier", + "applicationEventTypeDescriptor", "applicationIdentifier", "educationOrganizationId", "eventDate", @@ -23934,8 +23934,8 @@ "required": [ "administrationIdentifier", "assessmentIdentifier", - "namespace", - "assigningEducationOrganizationId" + "assigningEducationOrganizationId", + "namespace" ], "type": "object" }, @@ -28738,8 +28738,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -41981,9 +41981,9 @@ }, "required": [ "calendarCode", + "date", "schoolId", - "schoolYear", - "date" + "schoolYear" ], "type": "object" }, @@ -121734,8 +121734,8 @@ } }, "required": [ - "educationOrganizationIdentificationSystemDescriptor", - "educationOrganizationId" + "educationOrganizationId", + "educationOrganizationIdentificationSystemDescriptor" ], "type": "object" }, @@ -141809,9 +141809,9 @@ } }, "required": [ - "evaluationElementTitle", "educationOrganizationId", "evaluationDate", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", @@ -143118,8 +143118,8 @@ } }, "required": [ - "evaluationElementTitle", "educationOrganizationId", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", @@ -144517,11 +144517,11 @@ } }, "required": [ - "evaluationObjectiveTitle", - "evaluationTitle", "educationOrganizationId", "evaluationDate", + "evaluationObjectiveTitle", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "personId", @@ -145751,8 +145751,8 @@ } }, "required": [ - "evaluationObjectiveTitle", "educationOrganizationId", + "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", "performanceEvaluationTitle", @@ -149608,12 +149608,12 @@ } }, "required": [ - "evaluationDate", - "evaluationTitle", - "performanceEvaluationTypeDescriptor", "educationOrganizationId", + "evaluationDate", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", "personId", "schoolYear", "sourceSystemDescriptor", @@ -152662,9 +152662,9 @@ } }, "required": [ - "evaluationTitle", "educationOrganizationId", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "schoolYear", @@ -156795,12 +156795,12 @@ "required": [ "beginDate", "fieldworkIdentifier", - "studentUniqueId", "localCourseCode", "schoolId", "schoolYear", "sectionIdentifier", - "sessionName" + "sessionName", + "studentUniqueId" ], "type": "object" }, @@ -170462,11 +170462,11 @@ } }, "required": [ + "beginDate", "gradeTypeDescriptor", "gradingPeriodDescriptor", "gradingPeriodName", "gradingPeriodSchoolYear", - "beginDate", "localCourseCode", "schoolId", "schoolYear", @@ -206794,8 +206794,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -207633,8 +207633,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -208520,8 +208520,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -212438,8 +212438,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -213325,8 +213325,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -224625,8 +224625,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -227700,9 +227700,9 @@ } }, "required": [ + "educationOrganizationId", "eventDate", "openStaffPositionEventTypeDescriptor", - "educationOrganizationId", "requisitionNumber" ], "type": "object" @@ -239386,9 +239386,9 @@ } }, "required": [ - "pathPhaseName", "educationOrganizationId", - "pathName" + "pathName", + "pathPhaseName" ], "type": "object" }, @@ -243631,10 +243631,10 @@ "evaluationPeriodDescriptor", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", - "schoolYear", - "termDescriptor", "personId", - "sourceSystemDescriptor" + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" ], "type": "object" }, @@ -257420,10 +257420,10 @@ }, "required": [ "attendanceDate", - "personId", - "sourceSystemDescriptor", "namespace", - "professionalDevelopmentTitle" + "personId", + "professionalDevelopmentTitle", + "sourceSystemDescriptor" ], "type": "object" }, @@ -263210,8 +263210,8 @@ } }, "required": [ - "programEvaluationElementTitle", "programEducationOrganizationId", + "programEvaluationElementTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -264362,8 +264362,8 @@ } }, "required": [ - "programEvaluationObjectiveTitle", "programEducationOrganizationId", + "programEvaluationObjectiveTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -266965,10 +266965,10 @@ } }, "required": [ + "programEducationOrganizationId", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", - "programEducationOrganizationId", "programName", "programTypeDescriptor" ], @@ -276845,17 +276845,17 @@ "required": [ "educationOrganizationId", "evaluationDate", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "personId", + "quantitativeMeasureIdentifier", "schoolYear", "sourceSystemDescriptor", - "termDescriptor", - "evaluationElementTitle", - "quantitativeMeasureIdentifier" + "termDescriptor" ], "type": "object" }, @@ -278742,9 +278742,9 @@ "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", + "quantitativeMeasureIdentifier", "schoolYear", - "termDescriptor", - "quantitativeMeasureIdentifier" + "termDescriptor" ], "type": "object" }, @@ -285479,10 +285479,10 @@ } }, "required": [ - "recruitmentEventAttendeeIdentifier", "educationOrganizationId", "eventDate", - "eventTitle" + "eventTitle", + "recruitmentEventAttendeeIdentifier" ], "type": "object" }, @@ -299090,9 +299090,9 @@ "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", + "rubricRating", "schoolYear", - "termDescriptor", - "rubricRating" + "termDescriptor" ], "type": "object" }, @@ -312388,8 +312388,8 @@ "localCourseCode", "schoolId", "schoolYear", - "sessionName", - "sectionIdentifier" + "sectionIdentifier", + "sessionName" ], "type": "object" }, @@ -345607,9 +345607,9 @@ } }, "required": [ + "assessmentIdentifier", "educationOrganizationAssociationTypeDescriptor", "educationOrganizationId", - "assessmentIdentifier", "namespace", "studentAssessmentIdentifier", "studentUniqueId" @@ -346595,8 +346595,8 @@ } }, "required": [ - "assessmentBatteryPartName", "administrationIdentifier", + "assessmentBatteryPartName", "assessmentIdentifier", "assigningEducationOrganizationId", "educationOrganizationId", @@ -347826,8 +347826,8 @@ "administrationIdentifier", "assessmentIdentifier", "assigningEducationOrganizationId", - "namespace", "educationOrganizationId", + "namespace", "studentUniqueId" ], "type": "object" @@ -354567,8 +354567,8 @@ "gradingPeriodName", "gradingPeriodSchoolId", "gradingPeriodSchoolYear", - "objectiveEducationOrganizationId", "objective", + "objectiveEducationOrganizationId", "objectiveGradeLevelDescriptor", "studentUniqueId" ], @@ -370628,8 +370628,8 @@ }, "required": [ "attendanceEventCategoryDescriptor", - "eventDate", "educationOrganizationId", + "eventDate", "interventionIdentificationCode", "studentUniqueId" ], @@ -375972,9 +375972,9 @@ } }, "required": [ + "educationOrganizationId", "pathMilestoneName", "pathMilestoneTypeDescriptor", - "educationOrganizationId", "pathName", "studentUniqueId" ], @@ -377004,9 +377004,9 @@ } }, "required": [ + "educationOrganizationId", "pathName", "pathPhaseName", - "educationOrganizationId", "studentUniqueId" ], "type": "object" @@ -401985,9 +401985,9 @@ }, "required": [ "educationOrganizationId", + "namespace", "programName", "programTypeDescriptor", - "namespace", "surveyIdentifier" ], "type": "object" @@ -404160,8 +404160,8 @@ } }, "required": [ - "questionCode", "namespace", + "questionCode", "surveyIdentifier" ], "type": "object" @@ -405769,9 +405769,9 @@ } }, "required": [ + "namespace", "personId", "sourceSystemDescriptor", - "namespace", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -406562,8 +406562,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -408845,15 +408845,15 @@ "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", + "namespace", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "personId", "schoolYear", "sourceSystemDescriptor", - "termDescriptor", - "namespace", "surveyIdentifier", - "surveySectionTitle" + "surveySectionTitle", + "termDescriptor" ], "type": "object" }, @@ -409901,11 +409901,11 @@ }, "required": [ "localCourseCode", + "namespace", "schoolId", "schoolYear", "sectionIdentifier", "sessionName", - "namespace", "surveyIdentifier" ], "type": "object" @@ -411619,9 +411619,9 @@ } }, "required": [ + "namespace", "personId", "sourceSystemDescriptor", - "namespace", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" @@ -412463,8 +412463,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" @@ -413315,9 +413315,9 @@ } }, "required": [ - "surveyResponseIdentifier", "namespace", "surveyIdentifier", + "surveyResponseIdentifier", "surveySectionTitle" ], "type": "object" 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 a4a77991b..e38bc2924 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 @@ -19899,8 +19899,8 @@ } }, "required": [ - "applicationEventTypeDescriptor", "applicantProfileIdentifier", + "applicationEventTypeDescriptor", "applicationIdentifier", "educationOrganizationId", "eventDate", @@ -24909,8 +24909,8 @@ "required": [ "administrationIdentifier", "assessmentIdentifier", - "namespace", - "assigningEducationOrganizationId" + "assigningEducationOrganizationId", + "namespace" ], "type": "object" }, @@ -29713,8 +29713,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -42971,9 +42971,9 @@ }, "required": [ "calendarCode", + "date", "schoolId", - "schoolYear", - "date" + "schoolYear" ], "type": "object" }, @@ -123651,8 +123651,8 @@ } }, "required": [ - "educationOrganizationIdentificationSystemDescriptor", - "educationOrganizationId" + "educationOrganizationId", + "educationOrganizationIdentificationSystemDescriptor" ], "type": "object" }, @@ -143703,9 +143703,9 @@ } }, "required": [ - "evaluationElementTitle", "educationOrganizationId", "evaluationDate", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", @@ -145012,8 +145012,8 @@ } }, "required": [ - "evaluationElementTitle", "educationOrganizationId", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", @@ -146411,11 +146411,11 @@ } }, "required": [ - "evaluationObjectiveTitle", - "evaluationTitle", "educationOrganizationId", "evaluationDate", + "evaluationObjectiveTitle", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "personId", @@ -147645,8 +147645,8 @@ } }, "required": [ - "evaluationObjectiveTitle", "educationOrganizationId", + "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", "performanceEvaluationTitle", @@ -151492,12 +151492,12 @@ } }, "required": [ - "evaluationDate", - "evaluationTitle", - "performanceEvaluationTypeDescriptor", "educationOrganizationId", + "evaluationDate", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", "personId", "schoolYear", "sourceSystemDescriptor", @@ -154546,9 +154546,9 @@ } }, "required": [ - "evaluationTitle", "educationOrganizationId", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "schoolYear", @@ -160155,12 +160155,12 @@ "required": [ "beginDate", "fieldworkIdentifier", - "studentUniqueId", "localCourseCode", "schoolId", "schoolYear", "sectionIdentifier", - "sessionName" + "sessionName", + "studentUniqueId" ], "type": "object" }, @@ -174560,11 +174560,11 @@ } }, "required": [ + "beginDate", "gradeTypeDescriptor", "gradingPeriodDescriptor", "gradingPeriodName", "gradingPeriodSchoolYear", - "beginDate", "localCourseCode", "schoolId", "schoolYear", @@ -214156,8 +214156,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -214995,8 +214995,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -215882,8 +215882,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -219856,8 +219856,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear" ], @@ -220743,8 +220743,8 @@ } }, "required": [ - "asOfDate", "accountIdentifier", + "asOfDate", "educationOrganizationId", "fiscalYear", "staffUniqueId" @@ -232033,8 +232033,8 @@ }, "required": [ "assessmentIdentifier", - "namespace", - "identificationCode" + "identificationCode", + "namespace" ], "type": "object" }, @@ -235108,9 +235108,9 @@ } }, "required": [ + "educationOrganizationId", "eventDate", "openStaffPositionEventTypeDescriptor", - "educationOrganizationId", "requisitionNumber" ], "type": "object" @@ -246850,9 +246850,9 @@ } }, "required": [ - "pathPhaseName", "educationOrganizationId", - "pathName" + "pathName", + "pathPhaseName" ], "type": "object" }, @@ -251095,10 +251095,10 @@ "evaluationPeriodDescriptor", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", - "schoolYear", - "termDescriptor", "personId", - "sourceSystemDescriptor" + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" ], "type": "object" }, @@ -265075,10 +265075,10 @@ }, "required": [ "attendanceDate", - "personId", - "sourceSystemDescriptor", "namespace", - "professionalDevelopmentTitle" + "personId", + "professionalDevelopmentTitle", + "sourceSystemDescriptor" ], "type": "object" }, @@ -270870,8 +270870,8 @@ } }, "required": [ - "programEvaluationElementTitle", "programEducationOrganizationId", + "programEvaluationElementTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -272022,8 +272022,8 @@ } }, "required": [ - "programEvaluationObjectiveTitle", "programEducationOrganizationId", + "programEvaluationObjectiveTitle", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", @@ -274625,10 +274625,10 @@ } }, "required": [ + "programEducationOrganizationId", "programEvaluationPeriodDescriptor", "programEvaluationTitle", "programEvaluationTypeDescriptor", - "programEducationOrganizationId", "programName", "programTypeDescriptor" ], @@ -284505,17 +284505,17 @@ "required": [ "educationOrganizationId", "evaluationDate", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "personId", + "quantitativeMeasureIdentifier", "schoolYear", "sourceSystemDescriptor", - "termDescriptor", - "evaluationElementTitle", - "quantitativeMeasureIdentifier" + "termDescriptor" ], "type": "object" }, @@ -286402,9 +286402,9 @@ "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", + "quantitativeMeasureIdentifier", "schoolYear", - "termDescriptor", - "quantitativeMeasureIdentifier" + "termDescriptor" ], "type": "object" }, @@ -293094,10 +293094,10 @@ } }, "required": [ - "recruitmentEventAttendeeIdentifier", "educationOrganizationId", "eventDate", - "eventTitle" + "eventTitle", + "recruitmentEventAttendeeIdentifier" ], "type": "object" }, @@ -306715,9 +306715,9 @@ "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", + "rubricRating", "schoolYear", - "termDescriptor", - "rubricRating" + "termDescriptor" ], "type": "object" }, @@ -320074,8 +320074,8 @@ "localCourseCode", "schoolId", "schoolYear", - "sessionName", - "sectionIdentifier" + "sectionIdentifier", + "sessionName" ], "type": "object" }, @@ -356313,9 +356313,9 @@ } }, "required": [ + "assessmentIdentifier", "educationOrganizationAssociationTypeDescriptor", "educationOrganizationId", - "assessmentIdentifier", "namespace", "studentAssessmentIdentifier", "studentUniqueId" @@ -357305,8 +357305,8 @@ } }, "required": [ - "assessmentBatteryPartName", "administrationIdentifier", + "assessmentBatteryPartName", "assessmentIdentifier", "assigningEducationOrganizationId", "educationOrganizationId", @@ -358536,8 +358536,8 @@ "administrationIdentifier", "assessmentIdentifier", "assigningEducationOrganizationId", - "namespace", "educationOrganizationId", + "namespace", "studentUniqueId" ], "type": "object" @@ -365282,8 +365282,8 @@ "gradingPeriodName", "gradingPeriodSchoolId", "gradingPeriodSchoolYear", - "objectiveEducationOrganizationId", "objective", + "objectiveEducationOrganizationId", "objectiveGradeLevelDescriptor", "studentUniqueId" ], @@ -378960,9 +378960,9 @@ } }, "required": [ - "iepGoalIdentifier", "educationOrganizationId", "iepFinalizedDate", + "iepGoalIdentifier", "studentIEPIdentifier", "studentUniqueId" ], @@ -380262,11 +380262,11 @@ } }, "required": [ + "educationOrganizationId", + "iepFinalizedDate", "iepServiceDeliveryIdentifier", "serviceDeliveryDate", "serviceDeliveryDescriptor", - "educationOrganizationId", - "iepFinalizedDate", "studentIEPIdentifier", "studentUniqueId" ], @@ -381485,10 +381485,10 @@ } }, "required": [ - "servicePrescriptionDate", - "servicePrescriptionDescriptor", "educationOrganizationId", "iepFinalizedDate", + "servicePrescriptionDate", + "servicePrescriptionDescriptor", "studentIEPIdentifier", "studentUniqueId" ], @@ -386601,8 +386601,8 @@ }, "required": [ "attendanceEventCategoryDescriptor", - "eventDate", "educationOrganizationId", + "eventDate", "interventionIdentificationCode", "studentUniqueId" ], @@ -391945,9 +391945,9 @@ } }, "required": [ + "educationOrganizationId", "pathMilestoneName", "pathMilestoneTypeDescriptor", - "educationOrganizationId", "pathName", "studentUniqueId" ], @@ -392977,9 +392977,9 @@ } }, "required": [ + "educationOrganizationId", "pathName", "pathPhaseName", - "educationOrganizationId", "studentUniqueId" ], "type": "object" @@ -417965,9 +417965,9 @@ }, "required": [ "educationOrganizationId", + "namespace", "programName", "programTypeDescriptor", - "namespace", "surveyIdentifier" ], "type": "object" @@ -420140,8 +420140,8 @@ } }, "required": [ - "questionCode", "namespace", + "questionCode", "surveyIdentifier" ], "type": "object" @@ -421749,9 +421749,9 @@ } }, "required": [ + "namespace", "personId", "sourceSystemDescriptor", - "namespace", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -422542,8 +422542,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -424825,15 +424825,15 @@ "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", + "namespace", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "personId", "schoolYear", "sourceSystemDescriptor", - "termDescriptor", - "namespace", "surveyIdentifier", - "surveySectionTitle" + "surveySectionTitle", + "termDescriptor" ], "type": "object" }, @@ -425881,11 +425881,11 @@ }, "required": [ "localCourseCode", + "namespace", "schoolId", "schoolYear", "sectionIdentifier", "sessionName", - "namespace", "surveyIdentifier" ], "type": "object" @@ -427599,9 +427599,9 @@ } }, "required": [ + "namespace", "personId", "sourceSystemDescriptor", - "namespace", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" @@ -428443,8 +428443,8 @@ } }, "required": [ - "staffUniqueId", "namespace", + "staffUniqueId", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" @@ -429295,9 +429295,9 @@ } }, "required": [ - "surveyResponseIdentifier", "namespace", "surveyIdentifier", + "surveyResponseIdentifier", "surveySectionTitle" ], "type": "object" 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 021f3ccb9..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 @@ -12738,9 +12738,9 @@ } }, "required": [ - "evaluationElementTitle", "educationOrganizationId", "evaluationDate", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", @@ -14049,8 +14049,8 @@ } }, "required": [ - "evaluationElementTitle", "educationOrganizationId", + "evaluationElementTitle", "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", @@ -15450,11 +15450,11 @@ } }, "required": [ - "evaluationObjectiveTitle", - "evaluationTitle", "educationOrganizationId", "evaluationDate", + "evaluationObjectiveTitle", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "personId", @@ -16686,8 +16686,8 @@ } }, "required": [ - "evaluationObjectiveTitle", "educationOrganizationId", + "evaluationObjectiveTitle", "evaluationPeriodDescriptor", "evaluationTitle", "performanceEvaluationTitle", @@ -20525,12 +20525,12 @@ } }, "required": [ - "evaluationDate", - "evaluationTitle", - "performanceEvaluationTypeDescriptor", "educationOrganizationId", + "evaluationDate", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", "personId", "schoolYear", "sourceSystemDescriptor", @@ -22543,9 +22543,9 @@ } }, "required": [ - "evaluationTitle", "educationOrganizationId", "evaluationPeriodDescriptor", + "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", "schoolYear", @@ -27056,10 +27056,10 @@ "evaluationPeriodDescriptor", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", - "schoolYear", - "termDescriptor", "personId", - "sourceSystemDescriptor" + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" ], "type": "object" }, @@ -30109,9 +30109,9 @@ "evaluationTitle", "performanceEvaluationTitle", "performanceEvaluationTypeDescriptor", + "rubricRating", "schoolYear", - "termDescriptor", - "rubricRating" + "termDescriptor" ], "type": "object" }, @@ -31914,9 +31914,9 @@ } }, "required": [ + "namespace", "personId", "sourceSystemDescriptor", - "namespace", "surveyIdentifier", "surveyResponseIdentifier" ], @@ -32896,9 +32896,9 @@ } }, "required": [ + "namespace", "personId", "sourceSystemDescriptor", - "namespace", "surveyIdentifier", "surveyResponseIdentifier", "surveySectionTitle" From f9cc8818e6ee8a5cc61d38e699aacede94164733 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Thu, 11 Jun 2026 00:37:18 -0500 Subject: [PATCH 25/28] minimum --- .../src/enhancer/OpenApiSpecificationEnhancerBase.ts | 2 ++ 1 file changed, 2 insertions(+) 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 b3285af41..4bd14e705 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts @@ -111,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', }, @@ -120,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', }, From 34b7e728a0f0eddce154cfca74c9a821ba1e89a6 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Thu, 11 Jun 2026 00:55:10 -0500 Subject: [PATCH 26/28] school-year --- .../src/enhancer/SchoolYearHardCodedSchemaBuilder.ts | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) 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: [], From c9c9326b851565fd856fafa9df0dbb8b4dbb5191 Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Thu, 11 Jun 2026 01:09:12 -0500 Subject: [PATCH 27/28] test-fixuo --- .../test/enhancer/OpenApiBaseDocumentEnhancer.test.ts | 2 ++ .../artifact/v7_1/ds-5.0-api-schema-authoritative.json | 4 ++++ .../artifact/v7_2/ds-5.1-api-schema-authoritative.json | 4 ++++ .../artifact/v7_3/ds-5.2-api-schema-authoritative.json | 4 ++++ .../artifact/v7_3/ds-6.0-api-schema-authoritative.json | 4 ++++ .../artifact/v7_3/ds-6.1-api-schema-authoritative.json | 4 ++++ 6 files changed, 22 insertions(+) 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 defc56cb4..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 @@ -163,6 +163,7 @@ describe('OpenApiBaseDocumentEnhancer', () => { in: 'query', description: 'Used in synchronization to set sequence minimum ChangeVersion', schema: { + minimum: 0, type: 'integer', format: 'int64', }, @@ -172,6 +173,7 @@ describe('OpenApiBaseDocumentEnhancer', () => { in: 'query', description: 'Used in synchronization to set sequence maximum ChangeVersion', schema: { + minimum: 0, type: 'integer', format: 'int64', }, 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 e0fa6878d..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 @@ -1061,6 +1061,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1070,6 +1071,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1244,6 +1246,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1253,6 +1256,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, 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 f0d5e3436..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 @@ -1051,6 +1051,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1060,6 +1061,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1234,6 +1236,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1243,6 +1246,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, 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 2cb61c31c..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 @@ -1061,6 +1061,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1070,6 +1071,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1244,6 +1246,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1253,6 +1256,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, 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 203ad4a52..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 @@ -1146,6 +1146,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1155,6 +1156,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1329,6 +1331,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1338,6 +1341,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, 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 e38bc2924..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 @@ -1185,6 +1185,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1194,6 +1195,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1368,6 +1370,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1377,6 +1380,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, From db78918cb49d0fd752db1f927fc208e14f349ecb Mon Sep 17 00:00:00 2001 From: Brad Banister Date: Thu, 11 Jun 2026 10:47:35 -0500 Subject: [PATCH 28/28] review-improvements --- .../OpenApiChangeQuerySchemaBuilder.ts | 14 ++--- .../OpenApiTrackedChangeKeyFieldEnhancer.ts | 62 +++++++++++++++++-- ...enApiTrackedChangeKeyFieldEnhancer.test.ts | 29 +++++++++ 3 files changed, 94 insertions(+), 11 deletions(-) diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts index 82e7f6fbe..5aed8fbab 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts @@ -4,6 +4,7 @@ // 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'; @@ -74,13 +75,12 @@ function assertCanCreateIdentityFieldSchemasFrom( entity: TopLevelEntity, trackedChangeKeyFields: TrackedChangeKeyField[], ): void { - if (trackedChangeKeyFields.length === 0) { - throw new Error( - `Unable to create tracked-change key schema for ${entityDisplayNameFor( - entity, - )}. No tracked-change key fields were found.`, - ); - } + invariant( + trackedChangeKeyFields.length > 0, + `Unable to create tracked-change key schema for ${entityDisplayNameFor( + entity, + )}. No tracked-change key fields were found.`, + ); } /** diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts index c9a57f0de..ac2141904 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts @@ -11,16 +11,26 @@ import { 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. */ @@ -39,6 +49,53 @@ function trackedChangeKeyFieldNameFrom(flattenedIdentityProperty: FlattenedIdent 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. */ @@ -50,10 +107,7 @@ function trackedChangeKeyFieldsFrom(entity: TopLevelEntity): TrackedChangeKeyFie .filter((flattenedIdentityProperty: FlattenedIdentityProperty) => flattenedIdentityProperty.mergedAwayBy == null) .forEach((flattenedIdentityProperty: FlattenedIdentityProperty) => { const fieldName: TrackedChangeKeyFieldName = trackedChangeKeyFieldNameFrom(flattenedIdentityProperty); - trackedChangeKeyFieldsByName[fieldName] = { - fieldName, - sourceProperty: flattenedIdentityProperty.identityProperty, - }; + addTrackedChangeKeyField(trackedChangeKeyFieldsByName, entity, fieldName, flattenedIdentityProperty.identityProperty); }); return Object.values(trackedChangeKeyFieldsByName); 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 index ad26fbed1..d72c4d3a8 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts @@ -231,6 +231,35 @@ describe('OpenApiTrackedChangeKeyFieldEnhancer', () => { }); }); + 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();