{ "openapi": "3.0.1", "info": { "title": "Ed-Fi Operational Data Store API", "description": "The Ed-Fi ODS / API enables applications to read and write education data stored in an Ed-Fi ODS through a secure REST interface. \n***\n > *Note: Consumers of ODS / API information should sanitize all data for display and storage. The ODS / API 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", "version": "3" }, "servers": [ { "url": "https://api.ed-fi.org:443/v7.3/api/data/v3" } ], "paths": { "/ed-fi/absenceEventCategoryDescriptors": { "get": { "tags": [ "absenceEventCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAbsenceEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_absenceEventCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "absenceEventCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAbsenceEventCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"absenceEventCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_absenceEventCategoryDescriptor" } } }, "required": true, "x-bodyName": "absenceEventCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/absenceEventCategoryDescriptors/{id}": { "get": { "tags": [ "absenceEventCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAbsenceEventCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_absenceEventCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "absenceEventCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAbsenceEventCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"absenceEventCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_absenceEventCategoryDescriptor" } } }, "required": true, "x-bodyName": "absenceEventCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "absenceEventCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAbsenceEventCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/absenceEventCategoryDescriptors/deletes": { "get": { "tags": [ "absenceEventCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAbsenceEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_absenceEventCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/absenceEventCategoryDescriptors/keyChanges": { "get": { "tags": [ "absenceEventCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAbsenceEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_absenceEventCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/absenceEventCategoryDescriptors/partitions": { "get": { "tags": [ "absenceEventCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAbsenceEventCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/academicHonorCategoryDescriptors": { "get": { "tags": [ "academicHonorCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAcademicHonorCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_academicHonorCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "academicHonorCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAcademicHonorCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"academicHonorCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicHonorCategoryDescriptor" } } }, "required": true, "x-bodyName": "academicHonorCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/academicHonorCategoryDescriptors/{id}": { "get": { "tags": [ "academicHonorCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAcademicHonorCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicHonorCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "academicHonorCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAcademicHonorCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"academicHonorCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicHonorCategoryDescriptor" } } }, "required": true, "x-bodyName": "academicHonorCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "academicHonorCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAcademicHonorCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/academicHonorCategoryDescriptors/deletes": { "get": { "tags": [ "academicHonorCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAcademicHonorCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_academicHonorCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/academicHonorCategoryDescriptors/keyChanges": { "get": { "tags": [ "academicHonorCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAcademicHonorCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_academicHonorCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/academicHonorCategoryDescriptors/partitions": { "get": { "tags": [ "academicHonorCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAcademicHonorCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/academicSubjectDescriptors": { "get": { "tags": [ "academicSubjectDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAcademicSubjectDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_academicSubjectDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "academicSubjectDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAcademicSubjectDescriptor", "requestBody": { "description": "The JSON representation of the \"academicSubjectDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicSubjectDescriptor" } } }, "required": true, "x-bodyName": "academicSubjectDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/academicSubjectDescriptors/{id}": { "get": { "tags": [ "academicSubjectDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAcademicSubjectDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicSubjectDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "academicSubjectDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAcademicSubjectDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"academicSubjectDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicSubjectDescriptor" } } }, "required": true, "x-bodyName": "academicSubjectDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "academicSubjectDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAcademicSubjectDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/academicSubjectDescriptors/deletes": { "get": { "tags": [ "academicSubjectDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAcademicSubjectDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_academicSubjectDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/academicSubjectDescriptors/keyChanges": { "get": { "tags": [ "academicSubjectDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAcademicSubjectDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_academicSubjectDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/academicSubjectDescriptors/partitions": { "get": { "tags": [ "academicSubjectDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAcademicSubjectDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/academicWeeks": { "get": { "tags": [ "academicWeeks" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAcademicWeeks", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "weekIdentifier", "in": "query", "description": "The school label for the week.", "schema": { "maxLength": 80, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "The start date for the academic week. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The end date for the academic week. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "totalInstructionalDays", "in": "query", "description": "The total instructional days during the academic week.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_academicWeek" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "academicWeeks" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAcademicWeek", "requestBody": { "description": "The JSON representation of the \"academicWeek\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicWeek" } } }, "required": true, "x-bodyName": "academicWeek" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/academicWeeks/{id}": { "get": { "tags": [ "academicWeeks" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAcademicWeeksById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicWeek" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "academicWeeks" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"academicWeek\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_academicWeek" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "academicWeeks" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAcademicWeekById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/academicWeeks/deletes": { "get": { "tags": [ "academicWeeks" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAcademicWeeks", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_academicWeekDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/academicWeeks/keyChanges": { "get": { "tags": [ "academicWeeks" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAcademicWeeks", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_academicWeekKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/academicWeeks/partitions": { "get": { "tags": [ "academicWeeks" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAcademicWeeksPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "weekIdentifier", "in": "query", "description": "The school label for the week.", "schema": { "maxLength": 80, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "The start date for the academic week. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The end date for the academic week. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "totalInstructionalDays", "in": "query", "description": "The total instructional days during the academic week.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/accommodationDescriptors": { "get": { "tags": [ "accommodationDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAccommodationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_accommodationDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "accommodationDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAccommodationDescriptor", "requestBody": { "description": "The JSON representation of the \"accommodationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accommodationDescriptor" } } }, "required": true, "x-bodyName": "accommodationDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/accommodationDescriptors/{id}": { "get": { "tags": [ "accommodationDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAccommodationDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accommodationDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "accommodationDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAccommodationDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"accommodationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accommodationDescriptor" } } }, "required": true, "x-bodyName": "accommodationDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "accommodationDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAccommodationDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/accommodationDescriptors/deletes": { "get": { "tags": [ "accommodationDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAccommodationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_accommodationDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/accommodationDescriptors/keyChanges": { "get": { "tags": [ "accommodationDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAccommodationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_accommodationDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/accommodationDescriptors/partitions": { "get": { "tags": [ "accommodationDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAccommodationDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/accountabilityRatings": { "get": { "tags": [ "accountabilityRatings" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAccountabilityRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "ratingTitle", "in": "query", "description": "The title of the rating.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The school year for which the accountability rating is assessed.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "rating", "in": "query", "description": "An accountability rating level, designation, or assessment.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "ratingDate", "in": "query", "description": "The date the rating was awarded.", "schema": { "type": "string", "format": "date" } }, { "name": "ratingOrganization", "in": "query", "description": "The organization that assessed the rating.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "ratingProgram", "in": "query", "description": "The program associated with the accountability rating (e.g., NCLB, AEIS).", "schema": { "maxLength": 30, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_accountabilityRating" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "accountabilityRatings" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAccountabilityRating", "requestBody": { "description": "The JSON representation of the \"accountabilityRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accountabilityRating" } } }, "required": true, "x-bodyName": "accountabilityRating" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/accountabilityRatings/{id}": { "get": { "tags": [ "accountabilityRatings" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAccountabilityRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accountabilityRating" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "accountabilityRatings" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"accountabilityRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accountabilityRating" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "accountabilityRatings" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAccountabilityRatingById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/accountabilityRatings/deletes": { "get": { "tags": [ "accountabilityRatings" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAccountabilityRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_accountabilityRatingDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/accountabilityRatings/keyChanges": { "get": { "tags": [ "accountabilityRatings" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAccountabilityRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_accountabilityRatingKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/accountabilityRatings/partitions": { "get": { "tags": [ "accountabilityRatings" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAccountabilityRatingsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "ratingTitle", "in": "query", "description": "The title of the rating.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The school year for which the accountability rating is assessed.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "rating", "in": "query", "description": "An accountability rating level, designation, or assessment.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "ratingDate", "in": "query", "description": "The date the rating was awarded.", "schema": { "type": "string", "format": "date" } }, { "name": "ratingOrganization", "in": "query", "description": "The organization that assessed the rating.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "ratingProgram", "in": "query", "description": "The program associated with the accountability rating (e.g., NCLB, AEIS).", "schema": { "maxLength": 30, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/accountTypeDescriptors": { "get": { "tags": [ "accountTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAccountTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_accountTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "accountTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAccountTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"accountTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accountTypeDescriptor" } } }, "required": true, "x-bodyName": "accountTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/accountTypeDescriptors/{id}": { "get": { "tags": [ "accountTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAccountTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accountTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "accountTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAccountTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"accountTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_accountTypeDescriptor" } } }, "required": true, "x-bodyName": "accountTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "accountTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAccountTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/accountTypeDescriptors/deletes": { "get": { "tags": [ "accountTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAccountTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_accountTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/accountTypeDescriptors/keyChanges": { "get": { "tags": [ "accountTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAccountTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_accountTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/accountTypeDescriptors/partitions": { "get": { "tags": [ "accountTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAccountTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/accreditationStatusDescriptors": { "get": { "tags": [ "accreditationStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAccreditationStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_accreditationStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "accreditationStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAccreditationStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"accreditationStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_accreditationStatusDescriptor" } } }, "required": true, "x-bodyName": "accreditationStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/accreditationStatusDescriptors/{id}": { "get": { "tags": [ "accreditationStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAccreditationStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_accreditationStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "accreditationStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAccreditationStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"accreditationStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_accreditationStatusDescriptor" } } }, "required": true, "x-bodyName": "accreditationStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "accreditationStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAccreditationStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/accreditationStatusDescriptors/deletes": { "get": { "tags": [ "accreditationStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAccreditationStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_accreditationStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/accreditationStatusDescriptors/keyChanges": { "get": { "tags": [ "accreditationStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAccreditationStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_accreditationStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/accreditationStatusDescriptors/partitions": { "get": { "tags": [ "accreditationStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAccreditationStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/achievementCategoryDescriptors": { "get": { "tags": [ "achievementCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAchievementCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_achievementCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "achievementCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAchievementCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"achievementCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_achievementCategoryDescriptor" } } }, "required": true, "x-bodyName": "achievementCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/achievementCategoryDescriptors/{id}": { "get": { "tags": [ "achievementCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAchievementCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_achievementCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "achievementCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAchievementCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"achievementCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_achievementCategoryDescriptor" } } }, "required": true, "x-bodyName": "achievementCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "achievementCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAchievementCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/achievementCategoryDescriptors/deletes": { "get": { "tags": [ "achievementCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAchievementCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_achievementCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/achievementCategoryDescriptors/keyChanges": { "get": { "tags": [ "achievementCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAchievementCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_achievementCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/achievementCategoryDescriptors/partitions": { "get": { "tags": [ "achievementCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAchievementCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/additionalCreditTypeDescriptors": { "get": { "tags": [ "additionalCreditTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAdditionalCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_additionalCreditTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "additionalCreditTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAdditionalCreditTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"additionalCreditTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_additionalCreditTypeDescriptor" } } }, "required": true, "x-bodyName": "additionalCreditTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/additionalCreditTypeDescriptors/{id}": { "get": { "tags": [ "additionalCreditTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAdditionalCreditTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_additionalCreditTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "additionalCreditTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAdditionalCreditTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"additionalCreditTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_additionalCreditTypeDescriptor" } } }, "required": true, "x-bodyName": "additionalCreditTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "additionalCreditTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAdditionalCreditTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/additionalCreditTypeDescriptors/deletes": { "get": { "tags": [ "additionalCreditTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAdditionalCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_additionalCreditTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/additionalCreditTypeDescriptors/keyChanges": { "get": { "tags": [ "additionalCreditTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAdditionalCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_additionalCreditTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/additionalCreditTypeDescriptors/partitions": { "get": { "tags": [ "additionalCreditTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAdditionalCreditTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/addressTypeDescriptors": { "get": { "tags": [ "addressTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAddressTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_addressTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "addressTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAddressTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"addressTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_addressTypeDescriptor" } } }, "required": true, "x-bodyName": "addressTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/addressTypeDescriptors/{id}": { "get": { "tags": [ "addressTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAddressTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_addressTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "addressTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAddressTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"addressTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_addressTypeDescriptor" } } }, "required": true, "x-bodyName": "addressTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "addressTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAddressTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/addressTypeDescriptors/deletes": { "get": { "tags": [ "addressTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAddressTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_addressTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/addressTypeDescriptors/keyChanges": { "get": { "tags": [ "addressTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAddressTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_addressTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/addressTypeDescriptors/partitions": { "get": { "tags": [ "addressTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAddressTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/administrationEnvironmentDescriptors": { "get": { "tags": [ "administrationEnvironmentDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAdministrationEnvironmentDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_administrationEnvironmentDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "administrationEnvironmentDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAdministrationEnvironmentDescriptor", "requestBody": { "description": "The JSON representation of the \"administrationEnvironmentDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_administrationEnvironmentDescriptor" } } }, "required": true, "x-bodyName": "administrationEnvironmentDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/administrationEnvironmentDescriptors/{id}": { "get": { "tags": [ "administrationEnvironmentDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAdministrationEnvironmentDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_administrationEnvironmentDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "administrationEnvironmentDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAdministrationEnvironmentDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"administrationEnvironmentDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_administrationEnvironmentDescriptor" } } }, "required": true, "x-bodyName": "administrationEnvironmentDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "administrationEnvironmentDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAdministrationEnvironmentDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/administrationEnvironmentDescriptors/deletes": { "get": { "tags": [ "administrationEnvironmentDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAdministrationEnvironmentDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_administrationEnvironmentDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/administrationEnvironmentDescriptors/keyChanges": { "get": { "tags": [ "administrationEnvironmentDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAdministrationEnvironmentDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_administrationEnvironmentDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/administrationEnvironmentDescriptors/partitions": { "get": { "tags": [ "administrationEnvironmentDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAdministrationEnvironmentDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/administrativeFundingControlDescriptors": { "get": { "tags": [ "administrativeFundingControlDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAdministrativeFundingControlDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_administrativeFundingControlDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "administrativeFundingControlDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAdministrativeFundingControlDescriptor", "requestBody": { "description": "The JSON representation of the \"administrativeFundingControlDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_administrativeFundingControlDescriptor" } } }, "required": true, "x-bodyName": "administrativeFundingControlDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/administrativeFundingControlDescriptors/{id}": { "get": { "tags": [ "administrativeFundingControlDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAdministrativeFundingControlDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_administrativeFundingControlDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "administrativeFundingControlDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAdministrativeFundingControlDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"administrativeFundingControlDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_administrativeFundingControlDescriptor" } } }, "required": true, "x-bodyName": "administrativeFundingControlDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "administrativeFundingControlDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAdministrativeFundingControlDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/administrativeFundingControlDescriptors/deletes": { "get": { "tags": [ "administrativeFundingControlDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAdministrativeFundingControlDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_administrativeFundingControlDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/administrativeFundingControlDescriptors/keyChanges": { "get": { "tags": [ "administrativeFundingControlDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAdministrativeFundingControlDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_administrativeFundingControlDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/administrativeFundingControlDescriptors/partitions": { "get": { "tags": [ "administrativeFundingControlDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAdministrativeFundingControlDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/aidTypeDescriptors": { "get": { "tags": [ "aidTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAidTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_aidTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "aidTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAidTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"aidTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_aidTypeDescriptor" } } }, "required": true, "x-bodyName": "aidTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/aidTypeDescriptors/{id}": { "get": { "tags": [ "aidTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAidTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_aidTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "aidTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAidTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"aidTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_aidTypeDescriptor" } } }, "required": true, "x-bodyName": "aidTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "aidTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAidTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/aidTypeDescriptors/deletes": { "get": { "tags": [ "aidTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAidTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_aidTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/aidTypeDescriptors/keyChanges": { "get": { "tags": [ "aidTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAidTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_aidTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/aidTypeDescriptors/partitions": { "get": { "tags": [ "aidTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAidTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/ancestryEthnicOriginDescriptors": { "get": { "tags": [ "ancestryEthnicOriginDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAncestryEthnicOriginDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_ancestryEthnicOriginDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "ancestryEthnicOriginDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAncestryEthnicOriginDescriptor", "requestBody": { "description": "The JSON representation of the \"ancestryEthnicOriginDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_ancestryEthnicOriginDescriptor" } } }, "required": true, "x-bodyName": "ancestryEthnicOriginDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { "get": { "tags": [ "ancestryEthnicOriginDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAncestryEthnicOriginDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_ancestryEthnicOriginDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "ancestryEthnicOriginDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAncestryEthnicOriginDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"ancestryEthnicOriginDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_ancestryEthnicOriginDescriptor" } } }, "required": true, "x-bodyName": "ancestryEthnicOriginDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "ancestryEthnicOriginDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAncestryEthnicOriginDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/ancestryEthnicOriginDescriptors/deletes": { "get": { "tags": [ "ancestryEthnicOriginDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAncestryEthnicOriginDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_ancestryEthnicOriginDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/ancestryEthnicOriginDescriptors/keyChanges": { "get": { "tags": [ "ancestryEthnicOriginDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAncestryEthnicOriginDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_ancestryEthnicOriginDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/ancestryEthnicOriginDescriptors/partitions": { "get": { "tags": [ "ancestryEthnicOriginDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAncestryEthnicOriginDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessments": { "get": { "tags": [ "assessments" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "assessmentCategoryDescriptor", "in": "query", "description": "The category of an assessment based on format and content.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "adaptiveAssessment", "in": "query", "description": "Indicates that the assessment is adaptive.", "schema": { "type": "boolean" } }, { "name": "assessmentFamily", "in": "query", "description": "The assessment family this assessment is a member of.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "assessmentForm", "in": "query", "description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "assessmentTitle", "in": "query", "description": "The title or name of the assessment.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "assessmentVersion", "in": "query", "description": "The version identifier for the assessment.", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxRawScore", "in": "query", "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.", "schema": { "type": "number", "format": "double" } }, { "name": "nomenclature", "in": "query", "description": "Reflects the specific nomenclature used for assessment.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "revisionDate", "in": "query", "description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially.", "schema": { "type": "string", "format": "date" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "assessmentIdentificationSystemDescriptor", "in": "query", "description": "A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to an assessment.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "assigningOrganizationIdentificationCode", "in": "query", "description": "The organization code or name assigning the assessment identification code.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessment" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessments" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessment", "requestBody": { "description": "The JSON representation of the \"assessment\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessment" } } }, "required": true, "x-bodyName": "assessment" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessments/{id}": { "get": { "tags": [ "assessments" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessment" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessments" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessment\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessment" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessments" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessments/deletes": { "get": { "tags": [ "assessments" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessments/keyChanges": { "get": { "tags": [ "assessments" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessments/partitions": { "get": { "tags": [ "assessments" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "assessmentCategoryDescriptor", "in": "query", "description": "The category of an assessment based on format and content.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "adaptiveAssessment", "in": "query", "description": "Indicates that the assessment is adaptive.", "schema": { "type": "boolean" } }, { "name": "assessmentFamily", "in": "query", "description": "The assessment family this assessment is a member of.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "assessmentForm", "in": "query", "description": "Identifies the form of the assessment, for example a regular versus makeup form, multiple choice versus constructed response, etc.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "assessmentTitle", "in": "query", "description": "The title or name of the assessment.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "assessmentVersion", "in": "query", "description": "The version identifier for the assessment.", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxRawScore", "in": "query", "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.", "schema": { "type": "number", "format": "double" } }, { "name": "nomenclature", "in": "query", "description": "Reflects the specific nomenclature used for assessment.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "revisionDate", "in": "query", "description": "The month, day, and year that the conceptual design for the assessment was most recently revised substantially.", "schema": { "type": "string", "format": "date" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "assessmentIdentificationSystemDescriptor", "in": "query", "description": "A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to an assessment.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "assigningOrganizationIdentificationCode", "in": "query", "description": "The organization code or name assigning the assessment identification code.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentAdministrations": { "get": { "tags": [ "assessmentAdministrations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentAdministrations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "administrationIdentifier", "in": "query", "description": "The title or name of the assessment in the context of its administration.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assigningEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentAdministration" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentAdministrations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentAdministration", "requestBody": { "description": "The JSON representation of the \"assessmentAdministration\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentAdministration" } } }, "required": true, "x-bodyName": "assessmentAdministration" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentAdministrations/{id}": { "get": { "tags": [ "assessmentAdministrations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentAdministrationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentAdministration" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentAdministrations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentAdministration\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentAdministration" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentAdministrations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentAdministrationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentAdministrations/deletes": { "get": { "tags": [ "assessmentAdministrations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentAdministrations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentAdministrationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentAdministrations/keyChanges": { "get": { "tags": [ "assessmentAdministrations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentAdministrations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentAdministrationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentAdministrations/partitions": { "get": { "tags": [ "assessmentAdministrations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentAdministrationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "administrationIdentifier", "in": "query", "description": "The title or name of the assessment in the context of its administration.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assigningEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentAdministrationParticipations": { "get": { "tags": [ "assessmentAdministrationParticipations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentAdministrationParticipations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "administrationIdentifier", "in": "query", "description": "The title or name of the assessment in the context of its administration.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assigningEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "participatingEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentAdministrationParticipation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentAdministrationParticipations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentAdministrationParticipation", "requestBody": { "description": "The JSON representation of the \"assessmentAdministrationParticipation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentAdministrationParticipation" } } }, "required": true, "x-bodyName": "assessmentAdministrationParticipation" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentAdministrationParticipations/{id}": { "get": { "tags": [ "assessmentAdministrationParticipations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentAdministrationParticipationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentAdministrationParticipation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentAdministrationParticipations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentAdministrationParticipation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentAdministrationParticipation" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentAdministrationParticipations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentAdministrationParticipationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentAdministrationParticipations/deletes": { "get": { "tags": [ "assessmentAdministrationParticipations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentAdministrationParticipations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentAdministrationParticipationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentAdministrationParticipations/keyChanges": { "get": { "tags": [ "assessmentAdministrationParticipations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentAdministrationParticipations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentAdministrationParticipationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentAdministrationParticipations/partitions": { "get": { "tags": [ "assessmentAdministrationParticipations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentAdministrationParticipationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "administrationIdentifier", "in": "query", "description": "The title or name of the assessment in the context of its administration.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assigningEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "participatingEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentBatteryParts": { "get": { "tags": [ "assessmentBatteryParts" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentBatteryParts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "assessmentBatteryPartName", "in": "query", "description": "The name of the part of an assessment battery.", "schema": { "maxLength": 65, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentBatteryPart" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentBatteryParts" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentBatteryPart", "requestBody": { "description": "The JSON representation of the \"assessmentBatteryPart\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentBatteryPart" } } }, "required": true, "x-bodyName": "assessmentBatteryPart" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentBatteryParts/{id}": { "get": { "tags": [ "assessmentBatteryParts" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentBatteryPartsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentBatteryPart" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentBatteryParts" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentBatteryPart\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentBatteryPart" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentBatteryParts" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentBatteryPartById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentBatteryParts/deletes": { "get": { "tags": [ "assessmentBatteryParts" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentBatteryParts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentBatteryPartDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentBatteryParts/keyChanges": { "get": { "tags": [ "assessmentBatteryParts" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentBatteryParts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentBatteryPartKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentBatteryParts/partitions": { "get": { "tags": [ "assessmentBatteryParts" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentBatteryPartsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "assessmentBatteryPartName", "in": "query", "description": "The name of the part of an assessment battery.", "schema": { "maxLength": 65, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentCategoryDescriptors": { "get": { "tags": [ "assessmentCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"assessmentCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentCategoryDescriptor" } } }, "required": true, "x-bodyName": "assessmentCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentCategoryDescriptors/{id}": { "get": { "tags": [ "assessmentCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAssessmentCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentCategoryDescriptor" } } }, "required": true, "x-bodyName": "assessmentCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentCategoryDescriptors/deletes": { "get": { "tags": [ "assessmentCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentCategoryDescriptors/keyChanges": { "get": { "tags": [ "assessmentCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentCategoryDescriptors/partitions": { "get": { "tags": [ "assessmentCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentIdentificationSystemDescriptors": { "get": { "tags": [ "assessmentIdentificationSystemDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentIdentificationSystemDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentIdentificationSystemDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentIdentificationSystemDescriptor", "requestBody": { "description": "The JSON representation of the \"assessmentIdentificationSystemDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentIdentificationSystemDescriptor" } } }, "required": true, "x-bodyName": "assessmentIdentificationSystemDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { "get": { "tags": [ "assessmentIdentificationSystemDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentIdentificationSystemDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentIdentificationSystemDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentIdentificationSystemDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAssessmentIdentificationSystemDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentIdentificationSystemDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentIdentificationSystemDescriptor" } } }, "required": true, "x-bodyName": "assessmentIdentificationSystemDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentIdentificationSystemDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentIdentificationSystemDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentIdentificationSystemDescriptors/deletes": { "get": { "tags": [ "assessmentIdentificationSystemDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentIdentificationSystemDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentIdentificationSystemDescriptors/keyChanges": { "get": { "tags": [ "assessmentIdentificationSystemDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentIdentificationSystemDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentIdentificationSystemDescriptors/partitions": { "get": { "tags": [ "assessmentIdentificationSystemDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentIdentificationSystemDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentItems": { "get": { "tags": [ "assessmentItems" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentItems", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentItemCategoryDescriptor", "in": "query", "description": "Category or type of the assessment item.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "assessmentItemURI", "in": "query", "description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "expectedTimeAssessed", "in": "query", "description": "The duration allotted for the assessment item expressed in minutes.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "itemText", "in": "query", "description": "The text of the item.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "maxRawScore", "in": "query", "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.", "schema": { "type": "number", "format": "double" } }, { "name": "nomenclature", "in": "query", "description": "Reflects the specific nomenclature used for assessment item.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentItem" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentItems" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentItem", "requestBody": { "description": "The JSON representation of the \"assessmentItem\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItem" } } }, "required": true, "x-bodyName": "assessmentItem" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentItems/{id}": { "get": { "tags": [ "assessmentItems" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentItemsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItem" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentItems" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentItem\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItem" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentItems" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentItemById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentItems/deletes": { "get": { "tags": [ "assessmentItems" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentItems", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentItemDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentItems/keyChanges": { "get": { "tags": [ "assessmentItems" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentItems", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentItemKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentItems/partitions": { "get": { "tags": [ "assessmentItems" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentItemsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentItemCategoryDescriptor", "in": "query", "description": "Category or type of the assessment item.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "assessmentItemURI", "in": "query", "description": "The URI (typical a URL) pointing to the entry in an assessment item bank, which describes this content item.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "expectedTimeAssessed", "in": "query", "description": "The duration allotted for the assessment item expressed in minutes.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "itemText", "in": "query", "description": "The text of the item.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "maxRawScore", "in": "query", "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.", "schema": { "type": "number", "format": "double" } }, { "name": "nomenclature", "in": "query", "description": "Reflects the specific nomenclature used for assessment item.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentItemCategoryDescriptors": { "get": { "tags": [ "assessmentItemCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentItemCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentItemCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentItemCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentItemCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"assessmentItemCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItemCategoryDescriptor" } } }, "required": true, "x-bodyName": "assessmentItemCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentItemCategoryDescriptors/{id}": { "get": { "tags": [ "assessmentItemCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentItemCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItemCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentItemCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAssessmentItemCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentItemCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItemCategoryDescriptor" } } }, "required": true, "x-bodyName": "assessmentItemCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentItemCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentItemCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentItemCategoryDescriptors/deletes": { "get": { "tags": [ "assessmentItemCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentItemCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentItemCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentItemCategoryDescriptors/keyChanges": { "get": { "tags": [ "assessmentItemCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentItemCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentItemCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentItemCategoryDescriptors/partitions": { "get": { "tags": [ "assessmentItemCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentItemCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentItemResultDescriptors": { "get": { "tags": [ "assessmentItemResultDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentItemResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentItemResultDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentItemResultDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentItemResultDescriptor", "requestBody": { "description": "The JSON representation of the \"assessmentItemResultDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItemResultDescriptor" } } }, "required": true, "x-bodyName": "assessmentItemResultDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentItemResultDescriptors/{id}": { "get": { "tags": [ "assessmentItemResultDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentItemResultDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItemResultDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentItemResultDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAssessmentItemResultDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentItemResultDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentItemResultDescriptor" } } }, "required": true, "x-bodyName": "assessmentItemResultDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentItemResultDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentItemResultDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentItemResultDescriptors/deletes": { "get": { "tags": [ "assessmentItemResultDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentItemResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentItemResultDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentItemResultDescriptors/keyChanges": { "get": { "tags": [ "assessmentItemResultDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentItemResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentItemResultDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentItemResultDescriptors/partitions": { "get": { "tags": [ "assessmentItemResultDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentItemResultDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentPeriodDescriptors": { "get": { "tags": [ "assessmentPeriodDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentPeriodDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentPeriodDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentPeriodDescriptor", "requestBody": { "description": "The JSON representation of the \"assessmentPeriodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentPeriodDescriptor" } } }, "required": true, "x-bodyName": "assessmentPeriodDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentPeriodDescriptors/{id}": { "get": { "tags": [ "assessmentPeriodDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentPeriodDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentPeriodDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentPeriodDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAssessmentPeriodDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentPeriodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentPeriodDescriptor" } } }, "required": true, "x-bodyName": "assessmentPeriodDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentPeriodDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentPeriodDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentPeriodDescriptors/deletes": { "get": { "tags": [ "assessmentPeriodDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentPeriodDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentPeriodDescriptors/keyChanges": { "get": { "tags": [ "assessmentPeriodDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentPeriodDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentPeriodDescriptors/partitions": { "get": { "tags": [ "assessmentPeriodDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentPeriodDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentReportingMethodDescriptors": { "get": { "tags": [ "assessmentReportingMethodDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentReportingMethodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentReportingMethodDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentReportingMethodDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentReportingMethodDescriptor", "requestBody": { "description": "The JSON representation of the \"assessmentReportingMethodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentReportingMethodDescriptor" } } }, "required": true, "x-bodyName": "assessmentReportingMethodDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentReportingMethodDescriptors/{id}": { "get": { "tags": [ "assessmentReportingMethodDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentReportingMethodDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentReportingMethodDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentReportingMethodDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAssessmentReportingMethodDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentReportingMethodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentReportingMethodDescriptor" } } }, "required": true, "x-bodyName": "assessmentReportingMethodDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentReportingMethodDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentReportingMethodDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentReportingMethodDescriptors/deletes": { "get": { "tags": [ "assessmentReportingMethodDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentReportingMethodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentReportingMethodDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentReportingMethodDescriptors/keyChanges": { "get": { "tags": [ "assessmentReportingMethodDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentReportingMethodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentReportingMethodDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentReportingMethodDescriptors/partitions": { "get": { "tags": [ "assessmentReportingMethodDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentReportingMethodDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assessmentScoreRangeLearningStandards": { "get": { "tags": [ "assessmentScoreRangeLearningStandards" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssessmentScoreRangeLearningStandards", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "scoreRangeId", "in": "query", "description": "A unique number or alphanumeric code assigned to the score range associated with one or more learning standards.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "assessmentReportingMethodDescriptor", "in": "query", "description": "The assessment reporting method defined (e.g., scale score, RIT scale score) associated with the referenced learning standard(s).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maximumScore", "in": "query", "description": "The maximum score in the score range.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "minimumScore", "in": "query", "description": "The minimum score in the score range.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assessmentScoreRangeLearningStandard" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assessmentScoreRangeLearningStandards" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssessmentScoreRangeLearningStandard", "requestBody": { "description": "The JSON representation of the \"assessmentScoreRangeLearningStandard\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentScoreRangeLearningStandard" } } }, "required": true, "x-bodyName": "assessmentScoreRangeLearningStandard" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { "get": { "tags": [ "assessmentScoreRangeLearningStandards" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssessmentScoreRangeLearningStandardsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentScoreRangeLearningStandard" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assessmentScoreRangeLearningStandards" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assessmentScoreRangeLearningStandard\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assessmentScoreRangeLearningStandard" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assessmentScoreRangeLearningStandards" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssessmentScoreRangeLearningStandardById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assessmentScoreRangeLearningStandards/deletes": { "get": { "tags": [ "assessmentScoreRangeLearningStandards" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssessmentScoreRangeLearningStandards", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentScoreRangeLearningStandardDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentScoreRangeLearningStandards/keyChanges": { "get": { "tags": [ "assessmentScoreRangeLearningStandards" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssessmentScoreRangeLearningStandards", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assessmentScoreRangeLearningStandardKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assessmentScoreRangeLearningStandards/partitions": { "get": { "tags": [ "assessmentScoreRangeLearningStandards" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssessmentScoreRangeLearningStandardsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "scoreRangeId", "in": "query", "description": "A unique number or alphanumeric code assigned to the score range associated with one or more learning standards.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "assessmentReportingMethodDescriptor", "in": "query", "description": "The assessment reporting method defined (e.g., scale score, RIT scale score) associated with the referenced learning standard(s).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maximumScore", "in": "query", "description": "The maximum score in the score range.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "minimumScore", "in": "query", "description": "The minimum score in the score range.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/assignmentLateStatusDescriptors": { "get": { "tags": [ "assignmentLateStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAssignmentLateStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_assignmentLateStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "assignmentLateStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAssignmentLateStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"assignmentLateStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assignmentLateStatusDescriptor" } } }, "required": true, "x-bodyName": "assignmentLateStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assignmentLateStatusDescriptors/{id}": { "get": { "tags": [ "assignmentLateStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAssignmentLateStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assignmentLateStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "assignmentLateStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAssignmentLateStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"assignmentLateStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_assignmentLateStatusDescriptor" } } }, "required": true, "x-bodyName": "assignmentLateStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "assignmentLateStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAssignmentLateStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/assignmentLateStatusDescriptors/deletes": { "get": { "tags": [ "assignmentLateStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAssignmentLateStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assignmentLateStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assignmentLateStatusDescriptors/keyChanges": { "get": { "tags": [ "assignmentLateStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAssignmentLateStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_assignmentLateStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/assignmentLateStatusDescriptors/partitions": { "get": { "tags": [ "assignmentLateStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAssignmentLateStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/attemptStatusDescriptors": { "get": { "tags": [ "attemptStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAttemptStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_attemptStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "attemptStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAttemptStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"attemptStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_attemptStatusDescriptor" } } }, "required": true, "x-bodyName": "attemptStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/attemptStatusDescriptors/{id}": { "get": { "tags": [ "attemptStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAttemptStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_attemptStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "attemptStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAttemptStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"attemptStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_attemptStatusDescriptor" } } }, "required": true, "x-bodyName": "attemptStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "attemptStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAttemptStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/attemptStatusDescriptors/deletes": { "get": { "tags": [ "attemptStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAttemptStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_attemptStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/attemptStatusDescriptors/keyChanges": { "get": { "tags": [ "attemptStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAttemptStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_attemptStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/attemptStatusDescriptors/partitions": { "get": { "tags": [ "attemptStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAttemptStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/attendanceEventCategoryDescriptors": { "get": { "tags": [ "attendanceEventCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getAttendanceEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_attendanceEventCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "attendanceEventCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postAttendanceEventCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"attendanceEventCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_attendanceEventCategoryDescriptor" } } }, "required": true, "x-bodyName": "attendanceEventCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/attendanceEventCategoryDescriptors/{id}": { "get": { "tags": [ "attendanceEventCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getAttendanceEventCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_attendanceEventCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "attendanceEventCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putAttendanceEventCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"attendanceEventCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_attendanceEventCategoryDescriptor" } } }, "required": true, "x-bodyName": "attendanceEventCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "attendanceEventCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteAttendanceEventCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/attendanceEventCategoryDescriptors/deletes": { "get": { "tags": [ "attendanceEventCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesAttendanceEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_attendanceEventCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/attendanceEventCategoryDescriptors/keyChanges": { "get": { "tags": [ "attendanceEventCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesAttendanceEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_attendanceEventCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/attendanceEventCategoryDescriptors/partitions": { "get": { "tags": [ "attendanceEventCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getAttendanceEventCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/balanceSheetDimensions": { "get": { "tags": [ "balanceSheetDimensions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getBalanceSheetDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "code", "in": "query", "description": "The code representation of the account balance sheet dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account balance sheet dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account balance sheet dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_balanceSheetDimension" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "balanceSheetDimensions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postBalanceSheetDimension", "requestBody": { "description": "The JSON representation of the \"balanceSheetDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_balanceSheetDimension" } } }, "required": true, "x-bodyName": "balanceSheetDimension" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/balanceSheetDimensions/{id}": { "get": { "tags": [ "balanceSheetDimensions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getBalanceSheetDimensionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_balanceSheetDimension" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "balanceSheetDimensions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"balanceSheetDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_balanceSheetDimension" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "balanceSheetDimensions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteBalanceSheetDimensionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/balanceSheetDimensions/deletes": { "get": { "tags": [ "balanceSheetDimensions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesBalanceSheetDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_balanceSheetDimensionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/balanceSheetDimensions/keyChanges": { "get": { "tags": [ "balanceSheetDimensions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesBalanceSheetDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_balanceSheetDimensionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/balanceSheetDimensions/partitions": { "get": { "tags": [ "balanceSheetDimensions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getBalanceSheetDimensionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "code", "in": "query", "description": "The code representation of the account balance sheet dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account balance sheet dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account balance sheet dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/barrierToInternetAccessInResidenceDescriptors": { "get": { "tags": [ "barrierToInternetAccessInResidenceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getBarrierToInternetAccessInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_barrierToInternetAccessInResidenceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "barrierToInternetAccessInResidenceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postBarrierToInternetAccessInResidenceDescriptor", "requestBody": { "description": "The JSON representation of the \"barrierToInternetAccessInResidenceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_barrierToInternetAccessInResidenceDescriptor" } } }, "required": true, "x-bodyName": "barrierToInternetAccessInResidenceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { "get": { "tags": [ "barrierToInternetAccessInResidenceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getBarrierToInternetAccessInResidenceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_barrierToInternetAccessInResidenceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "barrierToInternetAccessInResidenceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putBarrierToInternetAccessInResidenceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"barrierToInternetAccessInResidenceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_barrierToInternetAccessInResidenceDescriptor" } } }, "required": true, "x-bodyName": "barrierToInternetAccessInResidenceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "barrierToInternetAccessInResidenceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteBarrierToInternetAccessInResidenceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/barrierToInternetAccessInResidenceDescriptors/deletes": { "get": { "tags": [ "barrierToInternetAccessInResidenceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesBarrierToInternetAccessInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_barrierToInternetAccessInResidenceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/barrierToInternetAccessInResidenceDescriptors/keyChanges": { "get": { "tags": [ "barrierToInternetAccessInResidenceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesBarrierToInternetAccessInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_barrierToInternetAccessInResidenceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/barrierToInternetAccessInResidenceDescriptors/partitions": { "get": { "tags": [ "barrierToInternetAccessInResidenceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getBarrierToInternetAccessInResidenceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/behaviorDescriptors": { "get": { "tags": [ "behaviorDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getBehaviorDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_behaviorDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "behaviorDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postBehaviorDescriptor", "requestBody": { "description": "The JSON representation of the \"behaviorDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_behaviorDescriptor" } } }, "required": true, "x-bodyName": "behaviorDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/behaviorDescriptors/{id}": { "get": { "tags": [ "behaviorDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getBehaviorDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_behaviorDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "behaviorDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putBehaviorDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"behaviorDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_behaviorDescriptor" } } }, "required": true, "x-bodyName": "behaviorDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "behaviorDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteBehaviorDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/behaviorDescriptors/deletes": { "get": { "tags": [ "behaviorDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesBehaviorDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_behaviorDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/behaviorDescriptors/keyChanges": { "get": { "tags": [ "behaviorDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesBehaviorDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_behaviorDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/behaviorDescriptors/partitions": { "get": { "tags": [ "behaviorDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getBehaviorDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/bellSchedules": { "get": { "tags": [ "bellSchedules" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getBellSchedules", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "bellScheduleName", "in": "query", "description": "Name or title of the bell schedule.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "alternateDayName", "in": "query", "description": "An alternate name for the day (e.g., Red, Blue).", "schema": { "maxLength": 20, "type": "string" } }, { "name": "endTime", "in": "query", "description": "An indication of the time of day the bell schedule ends.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "An indication of the time of day the bell schedule begins.", "schema": { "type": "string" } }, { "name": "totalInstructionalTime", "in": "query", "description": "The total instructional time in minutes per day for the bell schedule.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_bellSchedule" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "bellSchedules" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postBellSchedule", "requestBody": { "description": "The JSON representation of the \"bellSchedule\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_bellSchedule" } } }, "required": true, "x-bodyName": "bellSchedule" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/bellSchedules/{id}": { "get": { "tags": [ "bellSchedules" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getBellSchedulesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_bellSchedule" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "bellSchedules" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"bellSchedule\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_bellSchedule" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "bellSchedules" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteBellScheduleById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/bellSchedules/deletes": { "get": { "tags": [ "bellSchedules" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesBellSchedules", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_bellScheduleDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/bellSchedules/keyChanges": { "get": { "tags": [ "bellSchedules" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesBellSchedules", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_bellScheduleKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/bellSchedules/partitions": { "get": { "tags": [ "bellSchedules" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getBellSchedulesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "bellScheduleName", "in": "query", "description": "Name or title of the bell schedule.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "alternateDayName", "in": "query", "description": "An alternate name for the day (e.g., Red, Blue).", "schema": { "maxLength": 20, "type": "string" } }, { "name": "endTime", "in": "query", "description": "An indication of the time of day the bell schedule ends.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "An indication of the time of day the bell schedule begins.", "schema": { "type": "string" } }, { "name": "totalInstructionalTime", "in": "query", "description": "The total instructional time in minutes per day for the bell schedule.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/busRouteDescriptors": { "get": { "tags": [ "busRouteDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getBusRouteDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_busRouteDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "busRouteDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postBusRouteDescriptor", "requestBody": { "description": "The JSON representation of the \"busRouteDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_busRouteDescriptor" } } }, "required": true, "x-bodyName": "busRouteDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/busRouteDescriptors/{id}": { "get": { "tags": [ "busRouteDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getBusRouteDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_busRouteDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "busRouteDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putBusRouteDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"busRouteDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_busRouteDescriptor" } } }, "required": true, "x-bodyName": "busRouteDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "busRouteDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteBusRouteDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/busRouteDescriptors/deletes": { "get": { "tags": [ "busRouteDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesBusRouteDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_busRouteDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/busRouteDescriptors/keyChanges": { "get": { "tags": [ "busRouteDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesBusRouteDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_busRouteDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/busRouteDescriptors/partitions": { "get": { "tags": [ "busRouteDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getBusRouteDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/calendars": { "get": { "tags": [ "calendars" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCalendars", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "calendarCode", "in": "query", "description": "The identifier for the calendar.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year associated with the calendar.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "calendarTypeDescriptor", "in": "query", "description": "Indicates the type of calendar.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_calendar" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "calendars" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCalendar", "requestBody": { "description": "The JSON representation of the \"calendar\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendar" } } }, "required": true, "x-bodyName": "calendar" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/calendars/{id}": { "get": { "tags": [ "calendars" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCalendarsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendar" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "calendars" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"calendar\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendar" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "calendars" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCalendarById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/calendars/deletes": { "get": { "tags": [ "calendars" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCalendars", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_calendarDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/calendars/keyChanges": { "get": { "tags": [ "calendars" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCalendars", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_calendarKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/calendars/partitions": { "get": { "tags": [ "calendars" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCalendarsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "calendarCode", "in": "query", "description": "The identifier for the calendar.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year associated with the calendar.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "calendarTypeDescriptor", "in": "query", "description": "Indicates the type of calendar.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/calendarDates": { "get": { "tags": [ "calendarDates" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCalendarDates", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "date", "in": "query", "description": "The month, day, and year of the calendar event.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "calendarCode", "in": "query", "description": "The identifier for the calendar.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year associated with the calendar.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_calendarDate" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "calendarDates" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCalendarDate", "requestBody": { "description": "The JSON representation of the \"calendarDate\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarDate" } } }, "required": true, "x-bodyName": "calendarDate" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/calendarDates/{id}": { "get": { "tags": [ "calendarDates" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCalendarDatesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarDate" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "calendarDates" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"calendarDate\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarDate" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "calendarDates" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCalendarDateById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/calendarDates/deletes": { "get": { "tags": [ "calendarDates" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCalendarDates", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_calendarDateDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/calendarDates/keyChanges": { "get": { "tags": [ "calendarDates" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCalendarDates", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_calendarDateKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/calendarDates/partitions": { "get": { "tags": [ "calendarDates" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCalendarDatesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "date", "in": "query", "description": "The month, day, and year of the calendar event.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "calendarCode", "in": "query", "description": "The identifier for the calendar.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year associated with the calendar.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/calendarEventDescriptors": { "get": { "tags": [ "calendarEventDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCalendarEventDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_calendarEventDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "calendarEventDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCalendarEventDescriptor", "requestBody": { "description": "The JSON representation of the \"calendarEventDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarEventDescriptor" } } }, "required": true, "x-bodyName": "calendarEventDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/calendarEventDescriptors/{id}": { "get": { "tags": [ "calendarEventDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCalendarEventDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarEventDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "calendarEventDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCalendarEventDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"calendarEventDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarEventDescriptor" } } }, "required": true, "x-bodyName": "calendarEventDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "calendarEventDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCalendarEventDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/calendarEventDescriptors/deletes": { "get": { "tags": [ "calendarEventDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCalendarEventDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_calendarEventDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/calendarEventDescriptors/keyChanges": { "get": { "tags": [ "calendarEventDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCalendarEventDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_calendarEventDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/calendarEventDescriptors/partitions": { "get": { "tags": [ "calendarEventDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCalendarEventDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/calendarTypeDescriptors": { "get": { "tags": [ "calendarTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCalendarTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_calendarTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "calendarTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCalendarTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"calendarTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarTypeDescriptor" } } }, "required": true, "x-bodyName": "calendarTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/calendarTypeDescriptors/{id}": { "get": { "tags": [ "calendarTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCalendarTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "calendarTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCalendarTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"calendarTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_calendarTypeDescriptor" } } }, "required": true, "x-bodyName": "calendarTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "calendarTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCalendarTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/calendarTypeDescriptors/deletes": { "get": { "tags": [ "calendarTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCalendarTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_calendarTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/calendarTypeDescriptors/keyChanges": { "get": { "tags": [ "calendarTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCalendarTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_calendarTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/calendarTypeDescriptors/partitions": { "get": { "tags": [ "calendarTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCalendarTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/candidates": { "get": { "tags": [ "candidates" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCandidates", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "candidateIdentifier", "in": "query", "description": "A unique alphanumeric code assigned to a candidate.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" } }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "birthCountryDescriptor", "in": "query", "description": "The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "englishLanguageExamDescriptor", "in": "query", "description": "Indicates that a person passed, failed, or did not take an English Language assessment (e.g., TOEFFL).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "genderDescriptor", "in": "query", "description": "The gender of the candidate.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "limitedEnglishProficiencyDescriptor", "in": "query", "description": "An indication that the student has been identified as limited English proficient by the Language Proficiency Assessment Committee (LPAC), or English proficient.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "sexDescriptor", "in": "query", "description": "The sex of the candidate.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "birthSexDescriptor", "in": "query", "description": "A person's sex at birth.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "birthStateAbbreviationDescriptor", "in": "query", "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "birthCity", "in": "query", "description": "The city the student was born in.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "birthDate", "in": "query", "description": "The month, day, and year on which an individual was born.", "schema": { "type": "string", "format": "date" } }, { "name": "birthInternationalProvince", "in": "query", "description": "For students born outside of the U.S., the Province or jurisdiction in which an individual is born.", "schema": { "maxLength": 150, "type": "string" } }, { "name": "dateEnteredUS", "in": "query", "description": "For students born outside of the U.S., the date the student entered the U.S.", "schema": { "type": "string", "format": "date" } }, { "name": "displacementStatus", "in": "query", "description": "Indicates a state health or weather related event that displaces a group of students, and may require additional funding, educational, or social services.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "economicDisadvantaged", "in": "query", "description": "An indication of inadequate financial condition of an individual's family, as determined by family income, number of family members/dependents, participation in public assistance programs, and/or other characteristics considered relevant by federal, state, and local policy.", "schema": { "type": "boolean" } }, { "name": "firstGenerationStudent", "in": "query", "description": "Indicator of whether individual is a first generation college student.", "schema": { "type": "boolean" } }, { "name": "firstName", "in": "query", "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "generationCodeSuffix", "in": "query", "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", "schema": { "maxLength": 10, "type": "string" } }, { "name": "hispanicLatinoEthnicity", "in": "query", "description": "An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race. The term, \"Spanish origin,\" can be used in addition to \"Hispanic or Latino.\"", "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "lastSurname", "in": "query", "description": "The name borne in common by members of a family.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "maidenName", "in": "query", "description": "The individual's maiden name.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "middleName", "in": "query", "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "multipleBirthStatus", "in": "query", "description": "Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.)", "schema": { "type": "boolean" } }, { "name": "personalTitlePrefix", "in": "query", "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "preferredFirstName", "in": "query", "description": "The first name the individual prefers, if different from their legal first name", "schema": { "maxLength": 75, "type": "string" } }, { "name": "preferredLastSurname", "in": "query", "description": "The last name the individual prefers, if different from their legal last name", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_candidate" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "candidates" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCandidate", "requestBody": { "description": "The JSON representation of the \"candidate\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_candidate" } } }, "required": true, "x-bodyName": "candidate" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/candidates/{id}": { "get": { "tags": [ "candidates" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCandidatesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_candidate" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "candidates" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCandidate", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"candidate\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_candidate" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "candidates" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCandidateById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/candidates/deletes": { "get": { "tags": [ "candidates" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCandidates", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_candidateDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/candidates/keyChanges": { "get": { "tags": [ "candidates" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCandidates", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_candidateKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/candidates/partitions": { "get": { "tags": [ "candidates" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCandidatesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "candidateIdentifier", "in": "query", "description": "A unique alphanumeric code assigned to a candidate.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" } }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "birthCountryDescriptor", "in": "query", "description": "The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "englishLanguageExamDescriptor", "in": "query", "description": "Indicates that a person passed, failed, or did not take an English Language assessment (e.g., TOEFFL).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "genderDescriptor", "in": "query", "description": "The gender of the candidate.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "limitedEnglishProficiencyDescriptor", "in": "query", "description": "An indication that the student has been identified as limited English proficient by the Language Proficiency Assessment Committee (LPAC), or English proficient.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "sexDescriptor", "in": "query", "description": "The sex of the candidate.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "birthSexDescriptor", "in": "query", "description": "A person's sex at birth.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "birthStateAbbreviationDescriptor", "in": "query", "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "birthCity", "in": "query", "description": "The city the student was born in.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "birthDate", "in": "query", "description": "The month, day, and year on which an individual was born.", "schema": { "type": "string", "format": "date" } }, { "name": "birthInternationalProvince", "in": "query", "description": "For students born outside of the U.S., the Province or jurisdiction in which an individual is born.", "schema": { "maxLength": 150, "type": "string" } }, { "name": "dateEnteredUS", "in": "query", "description": "For students born outside of the U.S., the date the student entered the U.S.", "schema": { "type": "string", "format": "date" } }, { "name": "displacementStatus", "in": "query", "description": "Indicates a state health or weather related event that displaces a group of students, and may require additional funding, educational, or social services.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "economicDisadvantaged", "in": "query", "description": "An indication of inadequate financial condition of an individual's family, as determined by family income, number of family members/dependents, participation in public assistance programs, and/or other characteristics considered relevant by federal, state, and local policy.", "schema": { "type": "boolean" } }, { "name": "firstGenerationStudent", "in": "query", "description": "Indicator of whether individual is a first generation college student.", "schema": { "type": "boolean" } }, { "name": "firstName", "in": "query", "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "generationCodeSuffix", "in": "query", "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", "schema": { "maxLength": 10, "type": "string" } }, { "name": "hispanicLatinoEthnicity", "in": "query", "description": "An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race. The term, \"Spanish origin,\" can be used in addition to \"Hispanic or Latino.\"", "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "lastSurname", "in": "query", "description": "The name borne in common by members of a family.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "maidenName", "in": "query", "description": "The individual's maiden name.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "middleName", "in": "query", "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "multipleBirthStatus", "in": "query", "description": "Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.)", "schema": { "type": "boolean" } }, { "name": "personalTitlePrefix", "in": "query", "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "preferredFirstName", "in": "query", "description": "The first name the individual prefers, if different from their legal first name", "schema": { "maxLength": 75, "type": "string" } }, { "name": "preferredLastSurname", "in": "query", "description": "The last name the individual prefers, if different from their legal last name", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/candidateEducatorPreparationProgramAssociations": { "get": { "tags": [ "candidateEducatorPreparationProgramAssociations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCandidateEducatorPreparationProgramAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "beginDate", "in": "query", "description": "The begin date for the association. 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.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "candidateIdentifier", "in": "query", "description": "A unique alphanumeric code assigned to a candidate.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "programName", "in": "query", "description": "The name of the Educator Preparation Program.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programTypeDescriptor", "in": "query", "description": "The type of program.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "eppProgramPathwayDescriptor", "in": "query", "description": "The program pathway the candidate is following; for example: Residency, Internship, Traditional", "schema": { "maxLength": 306, "type": "string" } }, { "name": "reasonExitedDescriptor", "in": "query", "description": "Reason exited for the association.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "endDate", "in": "query", "description": "The end date for the association. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_candidateEducatorPreparationProgramAssociation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "candidateEducatorPreparationProgramAssociations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCandidateEducatorPreparationProgramAssociation", "requestBody": { "description": "The JSON representation of the \"candidateEducatorPreparationProgramAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_candidateEducatorPreparationProgramAssociation" } } }, "required": true, "x-bodyName": "candidateEducatorPreparationProgramAssociation" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/candidateEducatorPreparationProgramAssociations/{id}": { "get": { "tags": [ "candidateEducatorPreparationProgramAssociations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCandidateEducatorPreparationProgramAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_candidateEducatorPreparationProgramAssociation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "candidateEducatorPreparationProgramAssociations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCandidateEducatorPreparationProgramAssociation", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"candidateEducatorPreparationProgramAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_candidateEducatorPreparationProgramAssociation" } } }, "required": true, "x-bodyName": "candidateEducatorPreparationProgramAssociation" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "candidateEducatorPreparationProgramAssociations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCandidateEducatorPreparationProgramAssociationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/candidateEducatorPreparationProgramAssociations/deletes": { "get": { "tags": [ "candidateEducatorPreparationProgramAssociations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCandidateEducatorPreparationProgramAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_candidateEducatorPreparationProgramAssociationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/candidateEducatorPreparationProgramAssociations/keyChanges": { "get": { "tags": [ "candidateEducatorPreparationProgramAssociations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCandidateEducatorPreparationProgramAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_candidateEducatorPreparationProgramAssociationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/candidateEducatorPreparationProgramAssociations/partitions": { "get": { "tags": [ "candidateEducatorPreparationProgramAssociations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCandidateEducatorPreparationProgramAssociationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "beginDate", "in": "query", "description": "The begin date for the association. 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.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "candidateIdentifier", "in": "query", "description": "A unique alphanumeric code assigned to a candidate.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "programName", "in": "query", "description": "The name of the Educator Preparation Program.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programTypeDescriptor", "in": "query", "description": "The type of program.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "eppProgramPathwayDescriptor", "in": "query", "description": "The program pathway the candidate is following; for example: Residency, Internship, Traditional", "schema": { "maxLength": 306, "type": "string" } }, { "name": "reasonExitedDescriptor", "in": "query", "description": "Reason exited for the association.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "endDate", "in": "query", "description": "The end date for the association. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/careerPathwayDescriptors": { "get": { "tags": [ "careerPathwayDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCareerPathwayDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_careerPathwayDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "careerPathwayDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCareerPathwayDescriptor", "requestBody": { "description": "The JSON representation of the \"careerPathwayDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_careerPathwayDescriptor" } } }, "required": true, "x-bodyName": "careerPathwayDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/careerPathwayDescriptors/{id}": { "get": { "tags": [ "careerPathwayDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCareerPathwayDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_careerPathwayDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "careerPathwayDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCareerPathwayDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"careerPathwayDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_careerPathwayDescriptor" } } }, "required": true, "x-bodyName": "careerPathwayDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "careerPathwayDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCareerPathwayDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/careerPathwayDescriptors/deletes": { "get": { "tags": [ "careerPathwayDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCareerPathwayDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_careerPathwayDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/careerPathwayDescriptors/keyChanges": { "get": { "tags": [ "careerPathwayDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCareerPathwayDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_careerPathwayDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/careerPathwayDescriptors/partitions": { "get": { "tags": [ "careerPathwayDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCareerPathwayDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/certificationRouteDescriptors": { "get": { "tags": [ "certificationRouteDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCertificationRouteDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_certificationRouteDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "certificationRouteDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCertificationRouteDescriptor", "requestBody": { "description": "The JSON representation of the \"certificationRouteDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_certificationRouteDescriptor" } } }, "required": true, "x-bodyName": "certificationRouteDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/certificationRouteDescriptors/{id}": { "get": { "tags": [ "certificationRouteDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCertificationRouteDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_certificationRouteDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "certificationRouteDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCertificationRouteDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"certificationRouteDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_certificationRouteDescriptor" } } }, "required": true, "x-bodyName": "certificationRouteDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "certificationRouteDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCertificationRouteDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/certificationRouteDescriptors/deletes": { "get": { "tags": [ "certificationRouteDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCertificationRouteDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_certificationRouteDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/certificationRouteDescriptors/keyChanges": { "get": { "tags": [ "certificationRouteDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCertificationRouteDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_certificationRouteDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/certificationRouteDescriptors/partitions": { "get": { "tags": [ "certificationRouteDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCertificationRouteDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/charterApprovalAgencyTypeDescriptors": { "get": { "tags": [ "charterApprovalAgencyTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCharterApprovalAgencyTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_charterApprovalAgencyTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "charterApprovalAgencyTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCharterApprovalAgencyTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"charterApprovalAgencyTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_charterApprovalAgencyTypeDescriptor" } } }, "required": true, "x-bodyName": "charterApprovalAgencyTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { "get": { "tags": [ "charterApprovalAgencyTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCharterApprovalAgencyTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_charterApprovalAgencyTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "charterApprovalAgencyTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCharterApprovalAgencyTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"charterApprovalAgencyTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_charterApprovalAgencyTypeDescriptor" } } }, "required": true, "x-bodyName": "charterApprovalAgencyTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "charterApprovalAgencyTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCharterApprovalAgencyTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/charterApprovalAgencyTypeDescriptors/deletes": { "get": { "tags": [ "charterApprovalAgencyTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCharterApprovalAgencyTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_charterApprovalAgencyTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/charterApprovalAgencyTypeDescriptors/keyChanges": { "get": { "tags": [ "charterApprovalAgencyTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCharterApprovalAgencyTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_charterApprovalAgencyTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/charterApprovalAgencyTypeDescriptors/partitions": { "get": { "tags": [ "charterApprovalAgencyTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCharterApprovalAgencyTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/charterStatusDescriptors": { "get": { "tags": [ "charterStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCharterStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_charterStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "charterStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCharterStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"charterStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_charterStatusDescriptor" } } }, "required": true, "x-bodyName": "charterStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/charterStatusDescriptors/{id}": { "get": { "tags": [ "charterStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCharterStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_charterStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "charterStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCharterStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"charterStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_charterStatusDescriptor" } } }, "required": true, "x-bodyName": "charterStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "charterStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCharterStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/charterStatusDescriptors/deletes": { "get": { "tags": [ "charterStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCharterStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_charterStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/charterStatusDescriptors/keyChanges": { "get": { "tags": [ "charterStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCharterStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_charterStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/charterStatusDescriptors/partitions": { "get": { "tags": [ "charterStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCharterStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/chartOfAccounts": { "get": { "tags": [ "chartOfAccounts" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getChartOfAccounts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "accountIdentifier", "in": "query", "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "balanceSheetCode", "in": "query", "description": "The code representation of the account balance sheet dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "functionCode", "in": "query", "description": "The code representation of the account function dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "fundCode", "in": "query", "description": "The code representation of the account fund dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "objectCode", "in": "query", "description": "The code representation of the account object dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "operationalUnitCode", "in": "query", "description": "The code representation of the account operational unit dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "programCode", "in": "query", "description": "The code representation of the account program dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "projectCode", "in": "query", "description": "The code representation of the account project dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "sourceCode", "in": "query", "description": "The code representation of the account source dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "accountTypeDescriptor", "in": "query", "description": "The type of account used in accounting such as revenue, expenditure, or balance sheet.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "accountName", "in": "query", "description": "A descriptive name for the account.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_chartOfAccount" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "chartOfAccounts" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postChartOfAccount", "requestBody": { "description": "The JSON representation of the \"chartOfAccount\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_chartOfAccount" } } }, "required": true, "x-bodyName": "chartOfAccount" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/chartOfAccounts/{id}": { "get": { "tags": [ "chartOfAccounts" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getChartOfAccountsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_chartOfAccount" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "chartOfAccounts" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"chartOfAccount\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_chartOfAccount" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "chartOfAccounts" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteChartOfAccountById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/chartOfAccounts/deletes": { "get": { "tags": [ "chartOfAccounts" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesChartOfAccounts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_chartOfAccountDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/chartOfAccounts/keyChanges": { "get": { "tags": [ "chartOfAccounts" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesChartOfAccounts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_chartOfAccountKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/chartOfAccounts/partitions": { "get": { "tags": [ "chartOfAccounts" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getChartOfAccountsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "accountIdentifier", "in": "query", "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "balanceSheetCode", "in": "query", "description": "The code representation of the account balance sheet dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "functionCode", "in": "query", "description": "The code representation of the account function dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "fundCode", "in": "query", "description": "The code representation of the account fund dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "objectCode", "in": "query", "description": "The code representation of the account object dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "operationalUnitCode", "in": "query", "description": "The code representation of the account operational unit dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "programCode", "in": "query", "description": "The code representation of the account program dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "projectCode", "in": "query", "description": "The code representation of the account project dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "sourceCode", "in": "query", "description": "The code representation of the account source dimension.", "schema": { "maxLength": 16, "type": "string" } }, { "name": "accountTypeDescriptor", "in": "query", "description": "The type of account used in accounting such as revenue, expenditure, or balance sheet.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "accountName", "in": "query", "description": "A descriptive name for the account.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/citizenshipStatusDescriptors": { "get": { "tags": [ "citizenshipStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCitizenshipStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_citizenshipStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "citizenshipStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCitizenshipStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"citizenshipStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_citizenshipStatusDescriptor" } } }, "required": true, "x-bodyName": "citizenshipStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/citizenshipStatusDescriptors/{id}": { "get": { "tags": [ "citizenshipStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCitizenshipStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_citizenshipStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "citizenshipStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCitizenshipStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"citizenshipStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_citizenshipStatusDescriptor" } } }, "required": true, "x-bodyName": "citizenshipStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "citizenshipStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCitizenshipStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/citizenshipStatusDescriptors/deletes": { "get": { "tags": [ "citizenshipStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCitizenshipStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_citizenshipStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/citizenshipStatusDescriptors/keyChanges": { "get": { "tags": [ "citizenshipStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCitizenshipStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_citizenshipStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/citizenshipStatusDescriptors/partitions": { "get": { "tags": [ "citizenshipStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCitizenshipStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/classPeriods": { "get": { "tags": [ "classPeriods" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getClassPeriods", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "classPeriodName", "in": "query", "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "officialAttendancePeriod", "in": "query", "description": "Indicator of whether this class period is used for official daily attendance. Alternatively, official daily attendance may be tied to a section.", "schema": { "type": "boolean" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_classPeriod" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "classPeriods" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postClassPeriod", "requestBody": { "description": "The JSON representation of the \"classPeriod\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_classPeriod" } } }, "required": true, "x-bodyName": "classPeriod" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/classPeriods/{id}": { "get": { "tags": [ "classPeriods" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getClassPeriodsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_classPeriod" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "classPeriods" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, if natural key values are being updated by the JSON body, those changes will be applied to the resource and will also cascade through to dependent resources.", "operationId": "putClassPeriod", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"classPeriod\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_classPeriod" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } }, "x-Ed-Fi-isUpdatable": true }, "delete": { "tags": [ "classPeriods" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteClassPeriodById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/classPeriods/deletes": { "get": { "tags": [ "classPeriods" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesClassPeriods", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_classPeriodDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/classPeriods/keyChanges": { "get": { "tags": [ "classPeriods" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesClassPeriods", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_classPeriodKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/classPeriods/partitions": { "get": { "tags": [ "classPeriods" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getClassPeriodsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "classPeriodName", "in": "query", "description": "An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules).", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "officialAttendancePeriod", "in": "query", "description": "Indicator of whether this class period is used for official daily attendance. Alternatively, official daily attendance may be tied to a section.", "schema": { "type": "boolean" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/classroomPositionDescriptors": { "get": { "tags": [ "classroomPositionDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getClassroomPositionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_classroomPositionDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "classroomPositionDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postClassroomPositionDescriptor", "requestBody": { "description": "The JSON representation of the \"classroomPositionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_classroomPositionDescriptor" } } }, "required": true, "x-bodyName": "classroomPositionDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/classroomPositionDescriptors/{id}": { "get": { "tags": [ "classroomPositionDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getClassroomPositionDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_classroomPositionDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "classroomPositionDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putClassroomPositionDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"classroomPositionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_classroomPositionDescriptor" } } }, "required": true, "x-bodyName": "classroomPositionDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "classroomPositionDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteClassroomPositionDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/classroomPositionDescriptors/deletes": { "get": { "tags": [ "classroomPositionDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesClassroomPositionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_classroomPositionDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/classroomPositionDescriptors/keyChanges": { "get": { "tags": [ "classroomPositionDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesClassroomPositionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_classroomPositionDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/classroomPositionDescriptors/partitions": { "get": { "tags": [ "classroomPositionDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getClassroomPositionDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/cohorts": { "get": { "tags": [ "cohorts" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCohorts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "cohortIdentifier", "in": "query", "description": "The name or ID for the cohort.", "schema": { "maxLength": 36, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "academicSubjectDescriptor", "in": "query", "description": "The academic subject associated with an academic intervention.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "cohortScopeDescriptor", "in": "query", "description": "The scope of cohort (e.g., school, district, classroom).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "cohortTypeDescriptor", "in": "query", "description": "The type of cohort (e.g., academic intervention, classroom breakout).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "cohortDescription", "in": "query", "description": "The description of the cohort and its purpose.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_cohort" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "cohorts" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCohort", "requestBody": { "description": "The JSON representation of the \"cohort\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohort" } } }, "required": true, "x-bodyName": "cohort" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cohorts/{id}": { "get": { "tags": [ "cohorts" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCohortsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohort" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "cohorts" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"cohort\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohort" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "cohorts" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCohortById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cohorts/deletes": { "get": { "tags": [ "cohorts" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCohorts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cohortDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cohorts/keyChanges": { "get": { "tags": [ "cohorts" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCohorts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cohortKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cohorts/partitions": { "get": { "tags": [ "cohorts" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCohortsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "cohortIdentifier", "in": "query", "description": "The name or ID for the cohort.", "schema": { "maxLength": 36, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "academicSubjectDescriptor", "in": "query", "description": "The academic subject associated with an academic intervention.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "cohortScopeDescriptor", "in": "query", "description": "The scope of cohort (e.g., school, district, classroom).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "cohortTypeDescriptor", "in": "query", "description": "The type of cohort (e.g., academic intervention, classroom breakout).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "cohortDescription", "in": "query", "description": "The description of the cohort and its purpose.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/cohortScopeDescriptors": { "get": { "tags": [ "cohortScopeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCohortScopeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_cohortScopeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "cohortScopeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCohortScopeDescriptor", "requestBody": { "description": "The JSON representation of the \"cohortScopeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortScopeDescriptor" } } }, "required": true, "x-bodyName": "cohortScopeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cohortScopeDescriptors/{id}": { "get": { "tags": [ "cohortScopeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCohortScopeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortScopeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "cohortScopeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCohortScopeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"cohortScopeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortScopeDescriptor" } } }, "required": true, "x-bodyName": "cohortScopeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "cohortScopeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCohortScopeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cohortScopeDescriptors/deletes": { "get": { "tags": [ "cohortScopeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCohortScopeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cohortScopeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cohortScopeDescriptors/keyChanges": { "get": { "tags": [ "cohortScopeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCohortScopeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cohortScopeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cohortScopeDescriptors/partitions": { "get": { "tags": [ "cohortScopeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCohortScopeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/cohortTypeDescriptors": { "get": { "tags": [ "cohortTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCohortTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_cohortTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "cohortTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCohortTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"cohortTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortTypeDescriptor" } } }, "required": true, "x-bodyName": "cohortTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cohortTypeDescriptors/{id}": { "get": { "tags": [ "cohortTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCohortTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "cohortTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCohortTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"cohortTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortTypeDescriptor" } } }, "required": true, "x-bodyName": "cohortTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "cohortTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCohortTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cohortTypeDescriptors/deletes": { "get": { "tags": [ "cohortTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCohortTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cohortTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cohortTypeDescriptors/keyChanges": { "get": { "tags": [ "cohortTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCohortTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cohortTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cohortTypeDescriptors/partitions": { "get": { "tags": [ "cohortTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCohortTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/cohortYearTypeDescriptors": { "get": { "tags": [ "cohortYearTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCohortYearTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_cohortYearTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "cohortYearTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCohortYearTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"cohortYearTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortYearTypeDescriptor" } } }, "required": true, "x-bodyName": "cohortYearTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cohortYearTypeDescriptors/{id}": { "get": { "tags": [ "cohortYearTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCohortYearTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortYearTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "cohortYearTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCohortYearTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"cohortYearTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cohortYearTypeDescriptor" } } }, "required": true, "x-bodyName": "cohortYearTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "cohortYearTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCohortYearTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cohortYearTypeDescriptors/deletes": { "get": { "tags": [ "cohortYearTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCohortYearTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cohortYearTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cohortYearTypeDescriptors/keyChanges": { "get": { "tags": [ "cohortYearTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCohortYearTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cohortYearTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cohortYearTypeDescriptors/partitions": { "get": { "tags": [ "cohortYearTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCohortYearTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/communityOrganizations": { "get": { "tags": [ "communityOrganizations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCommunityOrganizations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "communityOrganizationId", "in": "query", "description": "The identifier assigned to a community organization. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_communityOrganization" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "communityOrganizations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCommunityOrganization", "requestBody": { "description": "The JSON representation of the \"communityOrganization\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityOrganization" } } }, "required": true, "x-bodyName": "communityOrganization" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/communityOrganizations/{id}": { "get": { "tags": [ "communityOrganizations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCommunityOrganizationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityOrganization" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "communityOrganizations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"communityOrganization\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityOrganization" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "communityOrganizations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCommunityOrganizationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/communityOrganizations/deletes": { "get": { "tags": [ "communityOrganizations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCommunityOrganizations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_communityOrganizationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/communityOrganizations/keyChanges": { "get": { "tags": [ "communityOrganizations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCommunityOrganizations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_communityOrganizationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/communityOrganizations/partitions": { "get": { "tags": [ "communityOrganizations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCommunityOrganizationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "communityOrganizationId", "in": "query", "description": "The identifier assigned to a community organization. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/communityProviders": { "get": { "tags": [ "communityProviders" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCommunityProviders", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "communityProviderId", "in": "query", "description": "The identifier assigned to a community provider. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "communityOrganizationId", "in": "query", "description": "The identifier assigned to a community organization. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "providerCategoryDescriptor", "in": "query", "description": "Indicates the category of the provider.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "providerProfitabilityDescriptor", "in": "query", "description": "Indicates the profitability status of the provider.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "providerStatusDescriptor", "in": "query", "description": "Indicates the status of the provider.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "licenseExemptIndicator", "in": "query", "description": "An indication of whether the provider is exempt from having a license.", "schema": { "type": "boolean" } }, { "name": "schoolIndicator", "in": "query", "description": "An indication of whether the community provider is a school.", "schema": { "type": "boolean" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_communityProvider" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "communityProviders" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCommunityProvider", "requestBody": { "description": "The JSON representation of the \"communityProvider\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityProvider" } } }, "required": true, "x-bodyName": "communityProvider" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/communityProviders/{id}": { "get": { "tags": [ "communityProviders" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCommunityProvidersById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityProvider" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "communityProviders" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"communityProvider\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityProvider" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "communityProviders" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCommunityProviderById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/communityProviders/deletes": { "get": { "tags": [ "communityProviders" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCommunityProviders", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_communityProviderDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/communityProviders/keyChanges": { "get": { "tags": [ "communityProviders" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCommunityProviders", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_communityProviderKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/communityProviders/partitions": { "get": { "tags": [ "communityProviders" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCommunityProvidersPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "communityProviderId", "in": "query", "description": "The identifier assigned to a community provider. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "communityOrganizationId", "in": "query", "description": "The identifier assigned to a community organization. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "providerCategoryDescriptor", "in": "query", "description": "Indicates the category of the provider.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "providerProfitabilityDescriptor", "in": "query", "description": "Indicates the profitability status of the provider.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "providerStatusDescriptor", "in": "query", "description": "Indicates the status of the provider.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "licenseExemptIndicator", "in": "query", "description": "An indication of whether the provider is exempt from having a license.", "schema": { "type": "boolean" } }, { "name": "schoolIndicator", "in": "query", "description": "An indication of whether the community provider is a school.", "schema": { "type": "boolean" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/communityProviderLicenses": { "get": { "tags": [ "communityProviderLicenses" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCommunityProviderLicenses", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "licenseIdentifier", "in": "query", "description": "The unique identifier issued by the licensing organization.", "schema": { "maxLength": 36, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "licensingOrganization", "in": "query", "description": "The organization issuing the license.", "schema": { "maxLength": 75, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "communityProviderId", "in": "query", "description": "The identifier assigned to a community provider. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "licenseStatusDescriptor", "in": "query", "description": "An indication of the status of the license.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "licenseTypeDescriptor", "in": "query", "description": "An indication of the category of the license.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "authorizedFacilityCapacity", "in": "query", "description": "The maximum number that can be contained or accommodated which a provider is authorized or licensed to serve.", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "licenseEffectiveDate", "in": "query", "description": "The month, day, and year on which a license is active or becomes effective. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "licenseExpirationDate", "in": "query", "description": "The month, day, and year on which a license will expire. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "licenseIssueDate", "in": "query", "description": "The month, day, and year on which an active license was issued.", "schema": { "type": "string", "format": "date" } }, { "name": "oldestAgeAuthorizedToServe", "in": "query", "description": "The oldest age of children a provider is authorized or licensed to serve.", "schema": { "type": "integer", "format": "int32" } }, { "name": "youngestAgeAuthorizedToServe", "in": "query", "description": "The youngest age of children a provider is authorized or licensed to serve.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_communityProviderLicense" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "communityProviderLicenses" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCommunityProviderLicense", "requestBody": { "description": "The JSON representation of the \"communityProviderLicense\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityProviderLicense" } } }, "required": true, "x-bodyName": "communityProviderLicense" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/communityProviderLicenses/{id}": { "get": { "tags": [ "communityProviderLicenses" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCommunityProviderLicensesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityProviderLicense" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "communityProviderLicenses" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"communityProviderLicense\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_communityProviderLicense" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "communityProviderLicenses" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCommunityProviderLicenseById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/communityProviderLicenses/deletes": { "get": { "tags": [ "communityProviderLicenses" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCommunityProviderLicenses", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_communityProviderLicenseDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/communityProviderLicenses/keyChanges": { "get": { "tags": [ "communityProviderLicenses" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCommunityProviderLicenses", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_communityProviderLicenseKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/communityProviderLicenses/partitions": { "get": { "tags": [ "communityProviderLicenses" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCommunityProviderLicensesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "licenseIdentifier", "in": "query", "description": "The unique identifier issued by the licensing organization.", "schema": { "maxLength": 36, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "licensingOrganization", "in": "query", "description": "The organization issuing the license.", "schema": { "maxLength": 75, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "communityProviderId", "in": "query", "description": "The identifier assigned to a community provider. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "licenseStatusDescriptor", "in": "query", "description": "An indication of the status of the license.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "licenseTypeDescriptor", "in": "query", "description": "An indication of the category of the license.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "authorizedFacilityCapacity", "in": "query", "description": "The maximum number that can be contained or accommodated which a provider is authorized or licensed to serve.", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "licenseEffectiveDate", "in": "query", "description": "The month, day, and year on which a license is active or becomes effective. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "licenseExpirationDate", "in": "query", "description": "The month, day, and year on which a license will expire. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "licenseIssueDate", "in": "query", "description": "The month, day, and year on which an active license was issued.", "schema": { "type": "string", "format": "date" } }, { "name": "oldestAgeAuthorizedToServe", "in": "query", "description": "The oldest age of children a provider is authorized or licensed to serve.", "schema": { "type": "integer", "format": "int32" } }, { "name": "youngestAgeAuthorizedToServe", "in": "query", "description": "The youngest age of children a provider is authorized or licensed to serve.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/competencyLevelDescriptors": { "get": { "tags": [ "competencyLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCompetencyLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_competencyLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "competencyLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCompetencyLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"competencyLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_competencyLevelDescriptor" } } }, "required": true, "x-bodyName": "competencyLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/competencyLevelDescriptors/{id}": { "get": { "tags": [ "competencyLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCompetencyLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_competencyLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "competencyLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCompetencyLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"competencyLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_competencyLevelDescriptor" } } }, "required": true, "x-bodyName": "competencyLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "competencyLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCompetencyLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/competencyLevelDescriptors/deletes": { "get": { "tags": [ "competencyLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCompetencyLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_competencyLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/competencyLevelDescriptors/keyChanges": { "get": { "tags": [ "competencyLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCompetencyLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_competencyLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/competencyLevelDescriptors/partitions": { "get": { "tags": [ "competencyLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCompetencyLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/competencyObjectives": { "get": { "tags": [ "competencyObjectives" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCompetencyObjectives", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "objectiveGradeLevelDescriptor", "in": "query", "description": "The grade level for which the competency objective is targeted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "objective", "in": "query", "description": "The designated title of the competency objective.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "competencyObjectiveId", "in": "query", "description": "The Identifier for the competency objective.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the student competency objective.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "successCriteria", "in": "query", "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a competency objective. This criteria gives clear indications as to the degree to which learning is moving through the Zone or Proximal Development toward independent achievement of the competency objective.", "schema": { "maxLength": 150, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_competencyObjective" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "competencyObjectives" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCompetencyObjective", "requestBody": { "description": "The JSON representation of the \"competencyObjective\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_competencyObjective" } } }, "required": true, "x-bodyName": "competencyObjective" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/competencyObjectives/{id}": { "get": { "tags": [ "competencyObjectives" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCompetencyObjectivesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_competencyObjective" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "competencyObjectives" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"competencyObjective\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_competencyObjective" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "competencyObjectives" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCompetencyObjectiveById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/competencyObjectives/deletes": { "get": { "tags": [ "competencyObjectives" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCompetencyObjectives", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_competencyObjectiveDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/competencyObjectives/keyChanges": { "get": { "tags": [ "competencyObjectives" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCompetencyObjectives", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_competencyObjectiveKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/competencyObjectives/partitions": { "get": { "tags": [ "competencyObjectives" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCompetencyObjectivesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "objectiveGradeLevelDescriptor", "in": "query", "description": "The grade level for which the competency objective is targeted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "objective", "in": "query", "description": "The designated title of the competency objective.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "competencyObjectiveId", "in": "query", "description": "The Identifier for the competency objective.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the student competency objective.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "successCriteria", "in": "query", "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a competency objective. This criteria gives clear indications as to the degree to which learning is moving through the Zone or Proximal Development toward independent achievement of the competency objective.", "schema": { "maxLength": 150, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/contacts": { "get": { "tags": [ "contacts" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getContacts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "contactUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a contact.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" } }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "highestCompletedLevelOfEducationDescriptor", "in": "query", "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "sexDescriptor", "in": "query", "description": "A person's birth sex.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "firstName", "in": "query", "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "genderIdentity", "in": "query", "description": "The gender the contact identifies themselves as.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "generationCodeSuffix", "in": "query", "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", "schema": { "maxLength": 10, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "lastSurname", "in": "query", "description": "The name borne in common by members of a family.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "loginId", "in": "query", "description": "The login ID for the user; used for security access control interface.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "maidenName", "in": "query", "description": "The individual's maiden name.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "middleName", "in": "query", "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "personalTitlePrefix", "in": "query", "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "preferredFirstName", "in": "query", "description": "The first name the individual prefers, if different from their legal first name", "schema": { "maxLength": 75, "type": "string" } }, { "name": "preferredLastSurname", "in": "query", "description": "The last name the individual prefers, if different from their legal last name", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_contact" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "contacts" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postContact", "requestBody": { "description": "The JSON representation of the \"contact\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contact" } } }, "required": true, "x-bodyName": "contact" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/contacts/{id}": { "get": { "tags": [ "contacts" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getContactsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contact" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "contacts" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"contact\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contact" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "contacts" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteContactById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/contacts/deletes": { "get": { "tags": [ "contacts" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesContacts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_contactDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/contacts/keyChanges": { "get": { "tags": [ "contacts" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesContacts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_contactKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/contacts/partitions": { "get": { "tags": [ "contacts" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getContactsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "contactUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a contact.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" } }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "highestCompletedLevelOfEducationDescriptor", "in": "query", "description": "The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "sexDescriptor", "in": "query", "description": "A person's birth sex.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "firstName", "in": "query", "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "genderIdentity", "in": "query", "description": "The gender the contact identifies themselves as.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "generationCodeSuffix", "in": "query", "description": "An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).", "schema": { "maxLength": 10, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "lastSurname", "in": "query", "description": "The name borne in common by members of a family.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "loginId", "in": "query", "description": "The login ID for the user; used for security access control interface.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "maidenName", "in": "query", "description": "The individual's maiden name.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "middleName", "in": "query", "description": "A secondary name given to an individual at birth, baptism, or during another naming ceremony.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "personalTitlePrefix", "in": "query", "description": "A prefix used to denote the title, degree, position, or seniority of the individual.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "preferredFirstName", "in": "query", "description": "The first name the individual prefers, if different from their legal first name", "schema": { "maxLength": 75, "type": "string" } }, { "name": "preferredLastSurname", "in": "query", "description": "The last name the individual prefers, if different from their legal last name", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/contactTypeDescriptors": { "get": { "tags": [ "contactTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getContactTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_contactTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "contactTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postContactTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"contactTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contactTypeDescriptor" } } }, "required": true, "x-bodyName": "contactTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/contactTypeDescriptors/{id}": { "get": { "tags": [ "contactTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getContactTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contactTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "contactTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putContactTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"contactTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contactTypeDescriptor" } } }, "required": true, "x-bodyName": "contactTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "contactTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteContactTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/contactTypeDescriptors/deletes": { "get": { "tags": [ "contactTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesContactTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_contactTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/contactTypeDescriptors/keyChanges": { "get": { "tags": [ "contactTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesContactTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_contactTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/contactTypeDescriptors/partitions": { "get": { "tags": [ "contactTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getContactTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/contentClassDescriptors": { "get": { "tags": [ "contentClassDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getContentClassDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_contentClassDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "contentClassDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postContentClassDescriptor", "requestBody": { "description": "The JSON representation of the \"contentClassDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contentClassDescriptor" } } }, "required": true, "x-bodyName": "contentClassDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/contentClassDescriptors/{id}": { "get": { "tags": [ "contentClassDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getContentClassDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contentClassDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "contentClassDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putContentClassDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"contentClassDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_contentClassDescriptor" } } }, "required": true, "x-bodyName": "contentClassDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "contentClassDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteContentClassDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/contentClassDescriptors/deletes": { "get": { "tags": [ "contentClassDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesContentClassDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_contentClassDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/contentClassDescriptors/keyChanges": { "get": { "tags": [ "contentClassDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesContentClassDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_contentClassDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/contentClassDescriptors/partitions": { "get": { "tags": [ "contentClassDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getContentClassDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/continuationOfServicesReasonDescriptors": { "get": { "tags": [ "continuationOfServicesReasonDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getContinuationOfServicesReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_continuationOfServicesReasonDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "continuationOfServicesReasonDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postContinuationOfServicesReasonDescriptor", "requestBody": { "description": "The JSON representation of the \"continuationOfServicesReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_continuationOfServicesReasonDescriptor" } } }, "required": true, "x-bodyName": "continuationOfServicesReasonDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { "get": { "tags": [ "continuationOfServicesReasonDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getContinuationOfServicesReasonDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_continuationOfServicesReasonDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "continuationOfServicesReasonDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putContinuationOfServicesReasonDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"continuationOfServicesReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_continuationOfServicesReasonDescriptor" } } }, "required": true, "x-bodyName": "continuationOfServicesReasonDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "continuationOfServicesReasonDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteContinuationOfServicesReasonDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/continuationOfServicesReasonDescriptors/deletes": { "get": { "tags": [ "continuationOfServicesReasonDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesContinuationOfServicesReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_continuationOfServicesReasonDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/continuationOfServicesReasonDescriptors/keyChanges": { "get": { "tags": [ "continuationOfServicesReasonDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesContinuationOfServicesReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_continuationOfServicesReasonDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/continuationOfServicesReasonDescriptors/partitions": { "get": { "tags": [ "continuationOfServicesReasonDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getContinuationOfServicesReasonDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/costRateDescriptors": { "get": { "tags": [ "costRateDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCostRateDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_costRateDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "costRateDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCostRateDescriptor", "requestBody": { "description": "The JSON representation of the \"costRateDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_costRateDescriptor" } } }, "required": true, "x-bodyName": "costRateDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/costRateDescriptors/{id}": { "get": { "tags": [ "costRateDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCostRateDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_costRateDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "costRateDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCostRateDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"costRateDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_costRateDescriptor" } } }, "required": true, "x-bodyName": "costRateDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "costRateDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCostRateDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/costRateDescriptors/deletes": { "get": { "tags": [ "costRateDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCostRateDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_costRateDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/costRateDescriptors/keyChanges": { "get": { "tags": [ "costRateDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCostRateDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_costRateDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/costRateDescriptors/partitions": { "get": { "tags": [ "costRateDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCostRateDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/coteachingStyleObservedDescriptors": { "get": { "tags": [ "coteachingStyleObservedDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCoteachingStyleObservedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_coteachingStyleObservedDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "coteachingStyleObservedDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCoteachingStyleObservedDescriptor", "requestBody": { "description": "The JSON representation of the \"coteachingStyleObservedDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_coteachingStyleObservedDescriptor" } } }, "required": true, "x-bodyName": "coteachingStyleObservedDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/coteachingStyleObservedDescriptors/{id}": { "get": { "tags": [ "coteachingStyleObservedDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCoteachingStyleObservedDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_coteachingStyleObservedDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "coteachingStyleObservedDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCoteachingStyleObservedDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"coteachingStyleObservedDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_coteachingStyleObservedDescriptor" } } }, "required": true, "x-bodyName": "coteachingStyleObservedDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "coteachingStyleObservedDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCoteachingStyleObservedDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/coteachingStyleObservedDescriptors/deletes": { "get": { "tags": [ "coteachingStyleObservedDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCoteachingStyleObservedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_coteachingStyleObservedDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/coteachingStyleObservedDescriptors/keyChanges": { "get": { "tags": [ "coteachingStyleObservedDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCoteachingStyleObservedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_coteachingStyleObservedDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/coteachingStyleObservedDescriptors/partitions": { "get": { "tags": [ "coteachingStyleObservedDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCoteachingStyleObservedDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/countryDescriptors": { "get": { "tags": [ "countryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCountryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_countryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "countryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCountryDescriptor", "requestBody": { "description": "The JSON representation of the \"countryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_countryDescriptor" } } }, "required": true, "x-bodyName": "countryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/countryDescriptors/{id}": { "get": { "tags": [ "countryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCountryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_countryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "countryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCountryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"countryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_countryDescriptor" } } }, "required": true, "x-bodyName": "countryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "countryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCountryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/countryDescriptors/deletes": { "get": { "tags": [ "countryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCountryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_countryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/countryDescriptors/keyChanges": { "get": { "tags": [ "countryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCountryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_countryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/countryDescriptors/partitions": { "get": { "tags": [ "countryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCountryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courses": { "get": { "tags": [ "courses" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourses", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "courseCode", "in": "query", "description": "A unique alphanumeric code assigned to a course.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "careerPathwayDescriptor", "in": "query", "description": "Indicates the career cluster or pathway the course is associated with as part of a CTE curriculum.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "courseDefinedByDescriptor", "in": "query", "description": "Specifies whether the course was defined by the SEA, LEA, School, or national organization.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "courseGPAApplicabilityDescriptor", "in": "query", "description": "An indicator of whether or not the course being described is included in the computation of the student's grade point average, and if so, if it is weighted differently from regular courses.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "minimumAvailableCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "maximumAvailableCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "courseDescription", "in": "query", "description": "A description of the content standards and goals covered in the course. Reference may be made to state or national content standards.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "courseTitle", "in": "query", "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "dateCourseAdopted", "in": "query", "description": "Date the course was adopted by the education agency.", "schema": { "type": "string", "format": "date" } }, { "name": "highSchoolCourseRequirement", "in": "query", "description": "An indication that this course may satisfy high school graduation requirements in the course's subject area.", "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxCompletionsForCredit", "in": "query", "description": "Designates how many times the course may be taken with credit received by the student.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maximumAvailableCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "maximumAvailableCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "minimumAvailableCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "minimumAvailableCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "numberOfParts", "in": "query", "description": "The number of parts identified for a course.", "schema": { "type": "integer", "format": "int32" } }, { "name": "timeRequiredForCompletion", "in": "query", "description": "The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "courseIdentificationSystemDescriptor", "in": "query", "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "assigningOrganizationIdentificationCode", "in": "query", "description": "The organization code or name assigning the Identification Code.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "courseCatalogURL", "in": "query", "description": "The URL for the course catalog that defines the course identification code.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_course" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courses" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourse", "requestBody": { "description": "The JSON representation of the \"course\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_course" } } }, "required": true, "x-bodyName": "course" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courses/{id}": { "get": { "tags": [ "courses" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCoursesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_course" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courses" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"course\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_course" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courses" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courses/deletes": { "get": { "tags": [ "courses" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourses", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courses/keyChanges": { "get": { "tags": [ "courses" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourses", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courses/partitions": { "get": { "tags": [ "courses" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCoursesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "courseCode", "in": "query", "description": "A unique alphanumeric code assigned to a course.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "careerPathwayDescriptor", "in": "query", "description": "Indicates the career cluster or pathway the course is associated with as part of a CTE curriculum.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "courseDefinedByDescriptor", "in": "query", "description": "Specifies whether the course was defined by the SEA, LEA, School, or national organization.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "courseGPAApplicabilityDescriptor", "in": "query", "description": "An indicator of whether or not the course being described is included in the computation of the student's grade point average, and if so, if it is weighted differently from regular courses.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "minimumAvailableCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "maximumAvailableCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "courseDescription", "in": "query", "description": "A description of the content standards and goals covered in the course. Reference may be made to state or national content standards.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "courseTitle", "in": "query", "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "dateCourseAdopted", "in": "query", "description": "Date the course was adopted by the education agency.", "schema": { "type": "string", "format": "date" } }, { "name": "highSchoolCourseRequirement", "in": "query", "description": "An indication that this course may satisfy high school graduation requirements in the course's subject area.", "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxCompletionsForCredit", "in": "query", "description": "Designates how many times the course may be taken with credit received by the student.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maximumAvailableCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "maximumAvailableCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "minimumAvailableCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "minimumAvailableCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "numberOfParts", "in": "query", "description": "The number of parts identified for a course.", "schema": { "type": "integer", "format": "int32" } }, { "name": "timeRequiredForCompletion", "in": "query", "description": "The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "courseIdentificationSystemDescriptor", "in": "query", "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "assigningOrganizationIdentificationCode", "in": "query", "description": "The organization code or name assigning the Identification Code.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "courseCatalogURL", "in": "query", "description": "The URL for the course catalog that defines the course identification code.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courseAttemptResultDescriptors": { "get": { "tags": [ "courseAttemptResultDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourseAttemptResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_courseAttemptResultDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courseAttemptResultDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourseAttemptResultDescriptor", "requestBody": { "description": "The JSON representation of the \"courseAttemptResultDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseAttemptResultDescriptor" } } }, "required": true, "x-bodyName": "courseAttemptResultDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseAttemptResultDescriptors/{id}": { "get": { "tags": [ "courseAttemptResultDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCourseAttemptResultDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseAttemptResultDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courseAttemptResultDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCourseAttemptResultDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"courseAttemptResultDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseAttemptResultDescriptor" } } }, "required": true, "x-bodyName": "courseAttemptResultDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courseAttemptResultDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseAttemptResultDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseAttemptResultDescriptors/deletes": { "get": { "tags": [ "courseAttemptResultDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourseAttemptResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseAttemptResultDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseAttemptResultDescriptors/keyChanges": { "get": { "tags": [ "courseAttemptResultDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourseAttemptResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseAttemptResultDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseAttemptResultDescriptors/partitions": { "get": { "tags": [ "courseAttemptResultDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCourseAttemptResultDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courseDefinedByDescriptors": { "get": { "tags": [ "courseDefinedByDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourseDefinedByDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_courseDefinedByDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courseDefinedByDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourseDefinedByDescriptor", "requestBody": { "description": "The JSON representation of the \"courseDefinedByDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseDefinedByDescriptor" } } }, "required": true, "x-bodyName": "courseDefinedByDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseDefinedByDescriptors/{id}": { "get": { "tags": [ "courseDefinedByDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCourseDefinedByDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseDefinedByDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courseDefinedByDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCourseDefinedByDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"courseDefinedByDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseDefinedByDescriptor" } } }, "required": true, "x-bodyName": "courseDefinedByDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courseDefinedByDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseDefinedByDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseDefinedByDescriptors/deletes": { "get": { "tags": [ "courseDefinedByDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourseDefinedByDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseDefinedByDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseDefinedByDescriptors/keyChanges": { "get": { "tags": [ "courseDefinedByDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourseDefinedByDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseDefinedByDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseDefinedByDescriptors/partitions": { "get": { "tags": [ "courseDefinedByDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCourseDefinedByDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courseGPAApplicabilityDescriptors": { "get": { "tags": [ "courseGPAApplicabilityDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourseGPAApplicabilityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_courseGPAApplicabilityDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courseGPAApplicabilityDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourseGPAApplicabilityDescriptor", "requestBody": { "description": "The JSON representation of the \"courseGPAApplicabilityDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseGPAApplicabilityDescriptor" } } }, "required": true, "x-bodyName": "courseGPAApplicabilityDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { "get": { "tags": [ "courseGPAApplicabilityDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCourseGPAApplicabilityDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseGPAApplicabilityDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courseGPAApplicabilityDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCourseGPAApplicabilityDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"courseGPAApplicabilityDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseGPAApplicabilityDescriptor" } } }, "required": true, "x-bodyName": "courseGPAApplicabilityDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courseGPAApplicabilityDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseGPAApplicabilityDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseGPAApplicabilityDescriptors/deletes": { "get": { "tags": [ "courseGPAApplicabilityDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourseGPAApplicabilityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseGPAApplicabilityDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseGPAApplicabilityDescriptors/keyChanges": { "get": { "tags": [ "courseGPAApplicabilityDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourseGPAApplicabilityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseGPAApplicabilityDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseGPAApplicabilityDescriptors/partitions": { "get": { "tags": [ "courseGPAApplicabilityDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCourseGPAApplicabilityDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courseIdentificationSystemDescriptors": { "get": { "tags": [ "courseIdentificationSystemDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourseIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_courseIdentificationSystemDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courseIdentificationSystemDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourseIdentificationSystemDescriptor", "requestBody": { "description": "The JSON representation of the \"courseIdentificationSystemDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseIdentificationSystemDescriptor" } } }, "required": true, "x-bodyName": "courseIdentificationSystemDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseIdentificationSystemDescriptors/{id}": { "get": { "tags": [ "courseIdentificationSystemDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCourseIdentificationSystemDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseIdentificationSystemDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courseIdentificationSystemDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCourseIdentificationSystemDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"courseIdentificationSystemDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseIdentificationSystemDescriptor" } } }, "required": true, "x-bodyName": "courseIdentificationSystemDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courseIdentificationSystemDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseIdentificationSystemDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseIdentificationSystemDescriptors/deletes": { "get": { "tags": [ "courseIdentificationSystemDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourseIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseIdentificationSystemDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseIdentificationSystemDescriptors/keyChanges": { "get": { "tags": [ "courseIdentificationSystemDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourseIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseIdentificationSystemDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseIdentificationSystemDescriptors/partitions": { "get": { "tags": [ "courseIdentificationSystemDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCourseIdentificationSystemDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courseLevelCharacteristicDescriptors": { "get": { "tags": [ "courseLevelCharacteristicDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourseLevelCharacteristicDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_courseLevelCharacteristicDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courseLevelCharacteristicDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourseLevelCharacteristicDescriptor", "requestBody": { "description": "The JSON representation of the \"courseLevelCharacteristicDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseLevelCharacteristicDescriptor" } } }, "required": true, "x-bodyName": "courseLevelCharacteristicDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { "get": { "tags": [ "courseLevelCharacteristicDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCourseLevelCharacteristicDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseLevelCharacteristicDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courseLevelCharacteristicDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCourseLevelCharacteristicDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"courseLevelCharacteristicDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseLevelCharacteristicDescriptor" } } }, "required": true, "x-bodyName": "courseLevelCharacteristicDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courseLevelCharacteristicDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseLevelCharacteristicDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseLevelCharacteristicDescriptors/deletes": { "get": { "tags": [ "courseLevelCharacteristicDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourseLevelCharacteristicDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseLevelCharacteristicDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseLevelCharacteristicDescriptors/keyChanges": { "get": { "tags": [ "courseLevelCharacteristicDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourseLevelCharacteristicDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseLevelCharacteristicDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseLevelCharacteristicDescriptors/partitions": { "get": { "tags": [ "courseLevelCharacteristicDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCourseLevelCharacteristicDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courseOfferings": { "get": { "tags": [ "courseOfferings" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourseOfferings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "localCourseCode", "in": "query", "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "sessionName", "in": "query", "description": "The identifier for the calendar for the academic session.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "courseCode", "in": "query", "description": "A unique alphanumeric code assigned to a course.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "instructionalTimePlanned", "in": "query", "description": "The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined course.", "schema": { "type": "integer", "format": "int32" } }, { "name": "localCourseTitle", "in": "query", "description": "The descriptive name given to a course of study offered in the school, if different from the course title.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_courseOffering" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courseOfferings" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourseOffering", "requestBody": { "description": "The JSON representation of the \"courseOffering\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseOffering" } } }, "required": true, "x-bodyName": "courseOffering" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseOfferings/{id}": { "get": { "tags": [ "courseOfferings" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCourseOfferingsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseOffering" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courseOfferings" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"courseOffering\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseOffering" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courseOfferings" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseOfferingById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseOfferings/deletes": { "get": { "tags": [ "courseOfferings" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourseOfferings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseOfferingDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseOfferings/keyChanges": { "get": { "tags": [ "courseOfferings" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourseOfferings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseOfferingKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseOfferings/partitions": { "get": { "tags": [ "courseOfferings" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCourseOfferingsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "localCourseCode", "in": "query", "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "sessionName", "in": "query", "description": "The identifier for the calendar for the academic session.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "courseCode", "in": "query", "description": "A unique alphanumeric code assigned to a course.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "instructionalTimePlanned", "in": "query", "description": "The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined course.", "schema": { "type": "integer", "format": "int32" } }, { "name": "localCourseTitle", "in": "query", "description": "The descriptive name given to a course of study offered in the school, if different from the course title.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courseRepeatCodeDescriptors": { "get": { "tags": [ "courseRepeatCodeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourseRepeatCodeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_courseRepeatCodeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courseRepeatCodeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourseRepeatCodeDescriptor", "requestBody": { "description": "The JSON representation of the \"courseRepeatCodeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseRepeatCodeDescriptor" } } }, "required": true, "x-bodyName": "courseRepeatCodeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseRepeatCodeDescriptors/{id}": { "get": { "tags": [ "courseRepeatCodeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCourseRepeatCodeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseRepeatCodeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courseRepeatCodeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCourseRepeatCodeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"courseRepeatCodeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseRepeatCodeDescriptor" } } }, "required": true, "x-bodyName": "courseRepeatCodeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courseRepeatCodeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseRepeatCodeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseRepeatCodeDescriptors/deletes": { "get": { "tags": [ "courseRepeatCodeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourseRepeatCodeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseRepeatCodeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseRepeatCodeDescriptors/keyChanges": { "get": { "tags": [ "courseRepeatCodeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourseRepeatCodeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseRepeatCodeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseRepeatCodeDescriptors/partitions": { "get": { "tags": [ "courseRepeatCodeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCourseRepeatCodeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/courseTranscripts": { "get": { "tags": [ "courseTranscripts" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCourseTranscripts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "courseAttemptResultDescriptor", "in": "query", "description": "The result from the student's attempt to take the course.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "courseCode", "in": "query", "description": "A unique alphanumeric code assigned to a course.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "courseEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "externalEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "responsibleTeacherStaffUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a responsibleteacherstaff.", "schema": { "maxLength": 32, "type": "string" } }, { "name": "courseRepeatCodeDescriptor", "in": "query", "description": "Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student's academic grade average.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "attemptedCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "earnedCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "whenTakenGradeLevelDescriptor", "in": "query", "description": "Student's grade level at time of course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "methodCreditEarnedDescriptor", "in": "query", "description": "The method the credits were earned.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "alternativeCourseTitle", "in": "query", "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "assigningOrganizationIdentificationCode", "in": "query", "description": "The organization code or name assigning the course identification code.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "attemptedCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "attemptedCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "courseCatalogURL", "in": "query", "description": "The URL for the course catalog that defines the course identification code.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "courseTitle", "in": "query", "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, language arts).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "earnedCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "earnedCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "externalEducationOrganizationNameOfInstitution", "in": "query", "description": "Name of the external institution where the student completed the course; to be used only when the reference external education organization is not available.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "finalLetterGradeEarned", "in": "query", "description": "The final indicator of student performance in a class as submitted by the instructor.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "finalNumericGradeEarned", "in": "query", "description": "The final indicator of student performance in a class as submitted by the instructor.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "courseIdentificationSystemDescriptor", "in": "query", "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "assigningOrganizationIdentificationCode", "in": "query", "description": "The organization code or name assigning the Identification Code.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "courseCatalogURL", "in": "query", "description": "The URL for the course catalog that defines the course identification code.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_courseTranscript" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "courseTranscripts" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCourseTranscript", "requestBody": { "description": "The JSON representation of the \"courseTranscript\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseTranscript" } } }, "required": true, "x-bodyName": "courseTranscript" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseTranscripts/{id}": { "get": { "tags": [ "courseTranscripts" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCourseTranscriptsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseTranscript" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "courseTranscripts" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"courseTranscript\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_courseTranscript" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "courseTranscripts" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCourseTranscriptById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/courseTranscripts/deletes": { "get": { "tags": [ "courseTranscripts" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCourseTranscripts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseTranscriptDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseTranscripts/keyChanges": { "get": { "tags": [ "courseTranscripts" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCourseTranscripts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_courseTranscriptKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/courseTranscripts/partitions": { "get": { "tags": [ "courseTranscripts" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCourseTranscriptsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "courseAttemptResultDescriptor", "in": "query", "description": "The result from the student's attempt to take the course.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "courseCode", "in": "query", "description": "A unique alphanumeric code assigned to a course.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "courseEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "externalEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "responsibleTeacherStaffUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a responsibleteacherstaff.", "schema": { "maxLength": 32, "type": "string" } }, { "name": "courseRepeatCodeDescriptor", "in": "query", "description": "Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student's academic grade average.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "attemptedCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "earnedCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "whenTakenGradeLevelDescriptor", "in": "query", "description": "Student's grade level at time of course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "methodCreditEarnedDescriptor", "in": "query", "description": "The method the credits were earned.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "alternativeCourseTitle", "in": "query", "description": "The descriptive name given to a course of study offered in the school, if different from the CourseTitle.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "assigningOrganizationIdentificationCode", "in": "query", "description": "The organization code or name assigning the course identification code.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "attemptedCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "attemptedCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "courseCatalogURL", "in": "query", "description": "The URL for the course catalog that defines the course identification code.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "courseTitle", "in": "query", "description": "The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, language arts).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "earnedCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "earnedCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "externalEducationOrganizationNameOfInstitution", "in": "query", "description": "Name of the external institution where the student completed the course; to be used only when the reference external education organization is not available.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "finalLetterGradeEarned", "in": "query", "description": "The final indicator of student performance in a class as submitted by the instructor.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "finalNumericGradeEarned", "in": "query", "description": "The final indicator of student performance in a class as submitted by the instructor.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "courseIdentificationSystemDescriptor", "in": "query", "description": "A system that is used to identify the organization of subject matter and related learning experiences provided for the instruction of students.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "assigningOrganizationIdentificationCode", "in": "query", "description": "The organization code or name assigning the Identification Code.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "courseCatalogURL", "in": "query", "description": "The URL for the course catalog that defines the course identification code.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a course by a school, school system, state, or other agency or entity. For multi-part course codes, concatenate the parts separated by a \"/\". For example, consider the following SCED code- subject = 20 Math course = 272 Geometry level = G General credits = 1.00 course sequence 1 of 1- would be entered as 20/272/G/1.00/1 of 1.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/credentials": { "get": { "tags": [ "credentials" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCredentials", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "stateOfIssueStateAbbreviationDescriptor", "in": "query", "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "credentialIdentifier", "in": "query", "description": "Identifier or serial number assigned to the credential.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "credentialFieldDescriptor", "in": "query", "description": "The field of certification for the certificate (e.g., Mathematics, Music).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "credentialTypeDescriptor", "in": "query", "description": "An indication of the category of credential an individual holds.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "teachingCredentialBasisDescriptor", "in": "query", "description": "An indication of the pre-determined criteria for granting the teaching credential that an individual holds.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "teachingCredentialDescriptor", "in": "query", "description": "An indication of the category of a legal document giving authorization to perform teaching assignment services.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "effectiveDate", "in": "query", "description": "The year, month and day on which an active credential held by an individual was issued. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "expirationDate", "in": "query", "description": "The month, day, and year on which an active credential held by an individual will expire. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "issuanceDate", "in": "query", "description": "The month, day, and year on which an active credential was issued to an individual.", "schema": { "type": "string", "format": "date" } }, { "name": "namespace", "in": "query", "description": "Namespace for the credential.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_credential" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "credentials" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCredential", "requestBody": { "description": "The JSON representation of the \"credential\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credential" } } }, "required": true, "x-bodyName": "credential" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/credentials/{id}": { "get": { "tags": [ "credentials" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCredentialsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credential" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "credentials" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"credential\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credential" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "credentials" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCredentialById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/credentials/deletes": { "get": { "tags": [ "credentials" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCredentials", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_credentialDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/credentials/keyChanges": { "get": { "tags": [ "credentials" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCredentials", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_credentialKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/credentials/partitions": { "get": { "tags": [ "credentials" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCredentialsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "stateOfIssueStateAbbreviationDescriptor", "in": "query", "description": "The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a license/credential was issued.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "credentialIdentifier", "in": "query", "description": "Identifier or serial number assigned to the credential.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "credentialFieldDescriptor", "in": "query", "description": "The field of certification for the certificate (e.g., Mathematics, Music).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "credentialTypeDescriptor", "in": "query", "description": "An indication of the category of credential an individual holds.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "teachingCredentialBasisDescriptor", "in": "query", "description": "An indication of the pre-determined criteria for granting the teaching credential that an individual holds.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "teachingCredentialDescriptor", "in": "query", "description": "An indication of the category of a legal document giving authorization to perform teaching assignment services.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "effectiveDate", "in": "query", "description": "The year, month and day on which an active credential held by an individual was issued. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "expirationDate", "in": "query", "description": "The month, day, and year on which an active credential held by an individual will expire. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "issuanceDate", "in": "query", "description": "The month, day, and year on which an active credential was issued to an individual.", "schema": { "type": "string", "format": "date" } }, { "name": "namespace", "in": "query", "description": "Namespace for the credential.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/credentialFieldDescriptors": { "get": { "tags": [ "credentialFieldDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCredentialFieldDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_credentialFieldDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "credentialFieldDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCredentialFieldDescriptor", "requestBody": { "description": "The JSON representation of the \"credentialFieldDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credentialFieldDescriptor" } } }, "required": true, "x-bodyName": "credentialFieldDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/credentialFieldDescriptors/{id}": { "get": { "tags": [ "credentialFieldDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCredentialFieldDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credentialFieldDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "credentialFieldDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCredentialFieldDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"credentialFieldDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credentialFieldDescriptor" } } }, "required": true, "x-bodyName": "credentialFieldDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "credentialFieldDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCredentialFieldDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/credentialFieldDescriptors/deletes": { "get": { "tags": [ "credentialFieldDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCredentialFieldDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_credentialFieldDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/credentialFieldDescriptors/keyChanges": { "get": { "tags": [ "credentialFieldDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCredentialFieldDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_credentialFieldDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/credentialFieldDescriptors/partitions": { "get": { "tags": [ "credentialFieldDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCredentialFieldDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/credentialStatusDescriptors": { "get": { "tags": [ "credentialStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCredentialStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_credentialStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "credentialStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCredentialStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"credentialStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_credentialStatusDescriptor" } } }, "required": true, "x-bodyName": "credentialStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/credentialStatusDescriptors/{id}": { "get": { "tags": [ "credentialStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCredentialStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_credentialStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "credentialStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCredentialStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"credentialStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_credentialStatusDescriptor" } } }, "required": true, "x-bodyName": "credentialStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "credentialStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCredentialStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/credentialStatusDescriptors/deletes": { "get": { "tags": [ "credentialStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCredentialStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_credentialStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/credentialStatusDescriptors/keyChanges": { "get": { "tags": [ "credentialStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCredentialStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_credentialStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/credentialStatusDescriptors/partitions": { "get": { "tags": [ "credentialStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCredentialStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/credentialTypeDescriptors": { "get": { "tags": [ "credentialTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCredentialTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_credentialTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "credentialTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCredentialTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"credentialTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credentialTypeDescriptor" } } }, "required": true, "x-bodyName": "credentialTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/credentialTypeDescriptors/{id}": { "get": { "tags": [ "credentialTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCredentialTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credentialTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "credentialTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCredentialTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"credentialTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_credentialTypeDescriptor" } } }, "required": true, "x-bodyName": "credentialTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "credentialTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCredentialTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/credentialTypeDescriptors/deletes": { "get": { "tags": [ "credentialTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCredentialTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_credentialTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/credentialTypeDescriptors/keyChanges": { "get": { "tags": [ "credentialTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCredentialTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_credentialTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/credentialTypeDescriptors/partitions": { "get": { "tags": [ "credentialTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCredentialTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/creditCategoryDescriptors": { "get": { "tags": [ "creditCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCreditCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_creditCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "creditCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCreditCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"creditCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_creditCategoryDescriptor" } } }, "required": true, "x-bodyName": "creditCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/creditCategoryDescriptors/{id}": { "get": { "tags": [ "creditCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCreditCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_creditCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "creditCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCreditCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"creditCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_creditCategoryDescriptor" } } }, "required": true, "x-bodyName": "creditCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "creditCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCreditCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/creditCategoryDescriptors/deletes": { "get": { "tags": [ "creditCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCreditCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_creditCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/creditCategoryDescriptors/keyChanges": { "get": { "tags": [ "creditCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCreditCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_creditCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/creditCategoryDescriptors/partitions": { "get": { "tags": [ "creditCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCreditCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/creditTypeDescriptors": { "get": { "tags": [ "creditTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_creditTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "creditTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCreditTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"creditTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_creditTypeDescriptor" } } }, "required": true, "x-bodyName": "creditTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/creditTypeDescriptors/{id}": { "get": { "tags": [ "creditTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCreditTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_creditTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "creditTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCreditTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"creditTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_creditTypeDescriptor" } } }, "required": true, "x-bodyName": "creditTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "creditTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCreditTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/creditTypeDescriptors/deletes": { "get": { "tags": [ "creditTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_creditTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/creditTypeDescriptors/keyChanges": { "get": { "tags": [ "creditTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_creditTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/creditTypeDescriptors/partitions": { "get": { "tags": [ "creditTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCreditTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/crisisEvents": { "get": { "tags": [ "crisisEvents" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCrisisEvents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "crisisEventName", "in": "query", "description": "The name of the crisis event that occurred. If there is no generally accepted name for this crisis event, the suggested format: Location + Crisis type + Year.", "schema": { "maxLength": 100, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "crisisTypeDescriptor", "in": "query", "description": "The type or category of crisis.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "crisisDescription", "in": "query", "description": "Provides a textual description of the crisis event affecting the student. It may include details such as the nature of the crisis (e.g., natural disaster, conflict, medical emergency), its severity, location, and any other relevant information describing the crisis situation.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "crisisEndDate", "in": "query", "description": "The date on which the crisis ceased to affect the student. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "crisisStartDate", "in": "query", "description": "The year, month and day on which the crisis affected the student. This date may not be the same as the date the crisis occurred if evacuation orders are implemented in anticipation of a crisis. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_crisisEvent" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "crisisEvents" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCrisisEvent", "requestBody": { "description": "The JSON representation of the \"crisisEvent\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_crisisEvent" } } }, "required": true, "x-bodyName": "crisisEvent" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/crisisEvents/{id}": { "get": { "tags": [ "crisisEvents" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCrisisEventsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_crisisEvent" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "crisisEvents" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"crisisEvent\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_crisisEvent" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "crisisEvents" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCrisisEventById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/crisisEvents/deletes": { "get": { "tags": [ "crisisEvents" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCrisisEvents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_crisisEventDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/crisisEvents/keyChanges": { "get": { "tags": [ "crisisEvents" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCrisisEvents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_crisisEventKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/crisisEvents/partitions": { "get": { "tags": [ "crisisEvents" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCrisisEventsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "crisisEventName", "in": "query", "description": "The name of the crisis event that occurred. If there is no generally accepted name for this crisis event, the suggested format: Location + Crisis type + Year.", "schema": { "maxLength": 100, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "crisisTypeDescriptor", "in": "query", "description": "The type or category of crisis.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "crisisDescription", "in": "query", "description": "Provides a textual description of the crisis event affecting the student. It may include details such as the nature of the crisis (e.g., natural disaster, conflict, medical emergency), its severity, location, and any other relevant information describing the crisis situation.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "crisisEndDate", "in": "query", "description": "The date on which the crisis ceased to affect the student. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "crisisStartDate", "in": "query", "description": "The year, month and day on which the crisis affected the student. This date may not be the same as the date the crisis occurred if evacuation orders are implemented in anticipation of a crisis. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/crisisTypeDescriptors": { "get": { "tags": [ "crisisTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCrisisTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_crisisTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "crisisTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCrisisTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"crisisTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_crisisTypeDescriptor" } } }, "required": true, "x-bodyName": "crisisTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/crisisTypeDescriptors/{id}": { "get": { "tags": [ "crisisTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCrisisTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_crisisTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "crisisTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCrisisTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"crisisTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_crisisTypeDescriptor" } } }, "required": true, "x-bodyName": "crisisTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "crisisTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCrisisTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/crisisTypeDescriptors/deletes": { "get": { "tags": [ "crisisTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCrisisTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_crisisTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/crisisTypeDescriptors/keyChanges": { "get": { "tags": [ "crisisTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCrisisTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_crisisTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/crisisTypeDescriptors/partitions": { "get": { "tags": [ "crisisTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCrisisTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/cteProgramServiceDescriptors": { "get": { "tags": [ "cteProgramServiceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCTEProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_cteProgramServiceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "cteProgramServiceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCTEProgramServiceDescriptor", "requestBody": { "description": "The JSON representation of the \"cteProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cteProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "cteProgramServiceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cteProgramServiceDescriptors/{id}": { "get": { "tags": [ "cteProgramServiceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCTEProgramServiceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cteProgramServiceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "cteProgramServiceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCTEProgramServiceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"cteProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_cteProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "cteProgramServiceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "cteProgramServiceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCTEProgramServiceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/cteProgramServiceDescriptors/deletes": { "get": { "tags": [ "cteProgramServiceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCTEProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cteProgramServiceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cteProgramServiceDescriptors/keyChanges": { "get": { "tags": [ "cteProgramServiceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCTEProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_cteProgramServiceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/cteProgramServiceDescriptors/partitions": { "get": { "tags": [ "cteProgramServiceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCTEProgramServiceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/curriculumUsedDescriptors": { "get": { "tags": [ "curriculumUsedDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getCurriculumUsedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_curriculumUsedDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "curriculumUsedDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postCurriculumUsedDescriptor", "requestBody": { "description": "The JSON representation of the \"curriculumUsedDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_curriculumUsedDescriptor" } } }, "required": true, "x-bodyName": "curriculumUsedDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/curriculumUsedDescriptors/{id}": { "get": { "tags": [ "curriculumUsedDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getCurriculumUsedDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_curriculumUsedDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "curriculumUsedDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putCurriculumUsedDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"curriculumUsedDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_curriculumUsedDescriptor" } } }, "required": true, "x-bodyName": "curriculumUsedDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "curriculumUsedDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteCurriculumUsedDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/curriculumUsedDescriptors/deletes": { "get": { "tags": [ "curriculumUsedDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesCurriculumUsedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_curriculumUsedDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/curriculumUsedDescriptors/keyChanges": { "get": { "tags": [ "curriculumUsedDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesCurriculumUsedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_curriculumUsedDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/curriculumUsedDescriptors/partitions": { "get": { "tags": [ "curriculumUsedDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getCurriculumUsedDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/deliveryMethodDescriptors": { "get": { "tags": [ "deliveryMethodDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDeliveryMethodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_deliveryMethodDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "deliveryMethodDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDeliveryMethodDescriptor", "requestBody": { "description": "The JSON representation of the \"deliveryMethodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_deliveryMethodDescriptor" } } }, "required": true, "x-bodyName": "deliveryMethodDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/deliveryMethodDescriptors/{id}": { "get": { "tags": [ "deliveryMethodDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDeliveryMethodDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_deliveryMethodDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "deliveryMethodDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDeliveryMethodDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"deliveryMethodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_deliveryMethodDescriptor" } } }, "required": true, "x-bodyName": "deliveryMethodDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "deliveryMethodDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDeliveryMethodDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/deliveryMethodDescriptors/deletes": { "get": { "tags": [ "deliveryMethodDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDeliveryMethodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_deliveryMethodDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/deliveryMethodDescriptors/keyChanges": { "get": { "tags": [ "deliveryMethodDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDeliveryMethodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_deliveryMethodDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/deliveryMethodDescriptors/partitions": { "get": { "tags": [ "deliveryMethodDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDeliveryMethodDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/descriptorMappings": { "get": { "tags": [ "descriptorMappings" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDescriptorMappings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "mappedNamespace", "in": "query", "description": "The namespace of the descriptor value to which the from descriptor value is mapped to.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "mappedValue", "in": "query", "description": "The descriptor value to which the from descriptor value is being mapped to.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "The namespace of the descriptor value that is being mapped to another value.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "value", "in": "query", "description": "The descriptor value that is being mapped to another value.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_descriptorMapping" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "descriptorMappings" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDescriptorMapping", "requestBody": { "description": "The JSON representation of the \"descriptorMapping\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_descriptorMapping" } } }, "required": true, "x-bodyName": "descriptorMapping" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/descriptorMappings/{id}": { "get": { "tags": [ "descriptorMappings" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDescriptorMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_descriptorMapping" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "descriptorMappings" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"descriptorMapping\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_descriptorMapping" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "descriptorMappings" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDescriptorMappingById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/descriptorMappings/deletes": { "get": { "tags": [ "descriptorMappings" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDescriptorMappings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_descriptorMappingDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/descriptorMappings/keyChanges": { "get": { "tags": [ "descriptorMappings" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDescriptorMappings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_descriptorMappingKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/descriptorMappings/partitions": { "get": { "tags": [ "descriptorMappings" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDescriptorMappingsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "mappedNamespace", "in": "query", "description": "The namespace of the descriptor value to which the from descriptor value is mapped to.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "mappedValue", "in": "query", "description": "The descriptor value to which the from descriptor value is being mapped to.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "The namespace of the descriptor value that is being mapped to another value.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "value", "in": "query", "description": "The descriptor value that is being mapped to another value.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/diagnosisDescriptors": { "get": { "tags": [ "diagnosisDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDiagnosisDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_diagnosisDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "diagnosisDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDiagnosisDescriptor", "requestBody": { "description": "The JSON representation of the \"diagnosisDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diagnosisDescriptor" } } }, "required": true, "x-bodyName": "diagnosisDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/diagnosisDescriptors/{id}": { "get": { "tags": [ "diagnosisDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDiagnosisDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diagnosisDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "diagnosisDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDiagnosisDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"diagnosisDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diagnosisDescriptor" } } }, "required": true, "x-bodyName": "diagnosisDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "diagnosisDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDiagnosisDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/diagnosisDescriptors/deletes": { "get": { "tags": [ "diagnosisDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDiagnosisDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_diagnosisDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/diagnosisDescriptors/keyChanges": { "get": { "tags": [ "diagnosisDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDiagnosisDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_diagnosisDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/diagnosisDescriptors/partitions": { "get": { "tags": [ "diagnosisDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDiagnosisDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/diplomaLevelDescriptors": { "get": { "tags": [ "diplomaLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDiplomaLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_diplomaLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "diplomaLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDiplomaLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"diplomaLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diplomaLevelDescriptor" } } }, "required": true, "x-bodyName": "diplomaLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/diplomaLevelDescriptors/{id}": { "get": { "tags": [ "diplomaLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDiplomaLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diplomaLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "diplomaLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDiplomaLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"diplomaLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diplomaLevelDescriptor" } } }, "required": true, "x-bodyName": "diplomaLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "diplomaLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDiplomaLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/diplomaLevelDescriptors/deletes": { "get": { "tags": [ "diplomaLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDiplomaLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_diplomaLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/diplomaLevelDescriptors/keyChanges": { "get": { "tags": [ "diplomaLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDiplomaLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_diplomaLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/diplomaLevelDescriptors/partitions": { "get": { "tags": [ "diplomaLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDiplomaLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/diplomaTypeDescriptors": { "get": { "tags": [ "diplomaTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDiplomaTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_diplomaTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "diplomaTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDiplomaTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"diplomaTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diplomaTypeDescriptor" } } }, "required": true, "x-bodyName": "diplomaTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/diplomaTypeDescriptors/{id}": { "get": { "tags": [ "diplomaTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDiplomaTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diplomaTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "diplomaTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDiplomaTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"diplomaTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_diplomaTypeDescriptor" } } }, "required": true, "x-bodyName": "diplomaTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "diplomaTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDiplomaTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/diplomaTypeDescriptors/deletes": { "get": { "tags": [ "diplomaTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDiplomaTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_diplomaTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/diplomaTypeDescriptors/keyChanges": { "get": { "tags": [ "diplomaTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDiplomaTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_diplomaTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/diplomaTypeDescriptors/partitions": { "get": { "tags": [ "diplomaTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDiplomaTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/disabilityDescriptors": { "get": { "tags": [ "disabilityDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisabilityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_disabilityDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "disabilityDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisabilityDescriptor", "requestBody": { "description": "The JSON representation of the \"disabilityDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDescriptor" } } }, "required": true, "x-bodyName": "disabilityDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disabilityDescriptors/{id}": { "get": { "tags": [ "disabilityDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisabilityDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "disabilityDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDisabilityDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"disabilityDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDescriptor" } } }, "required": true, "x-bodyName": "disabilityDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "disabilityDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisabilityDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disabilityDescriptors/deletes": { "get": { "tags": [ "disabilityDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisabilityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disabilityDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disabilityDescriptors/keyChanges": { "get": { "tags": [ "disabilityDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisabilityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disabilityDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disabilityDescriptors/partitions": { "get": { "tags": [ "disabilityDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisabilityDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/disabilityDesignationDescriptors": { "get": { "tags": [ "disabilityDesignationDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisabilityDesignationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_disabilityDesignationDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "disabilityDesignationDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisabilityDesignationDescriptor", "requestBody": { "description": "The JSON representation of the \"disabilityDesignationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDesignationDescriptor" } } }, "required": true, "x-bodyName": "disabilityDesignationDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disabilityDesignationDescriptors/{id}": { "get": { "tags": [ "disabilityDesignationDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisabilityDesignationDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDesignationDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "disabilityDesignationDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDisabilityDesignationDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"disabilityDesignationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDesignationDescriptor" } } }, "required": true, "x-bodyName": "disabilityDesignationDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "disabilityDesignationDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisabilityDesignationDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disabilityDesignationDescriptors/deletes": { "get": { "tags": [ "disabilityDesignationDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisabilityDesignationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disabilityDesignationDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disabilityDesignationDescriptors/keyChanges": { "get": { "tags": [ "disabilityDesignationDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisabilityDesignationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disabilityDesignationDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disabilityDesignationDescriptors/partitions": { "get": { "tags": [ "disabilityDesignationDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisabilityDesignationDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/disabilityDeterminationSourceTypeDescriptors": { "get": { "tags": [ "disabilityDeterminationSourceTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisabilityDeterminationSourceTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_disabilityDeterminationSourceTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "disabilityDeterminationSourceTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisabilityDeterminationSourceTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"disabilityDeterminationSourceTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDeterminationSourceTypeDescriptor" } } }, "required": true, "x-bodyName": "disabilityDeterminationSourceTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { "get": { "tags": [ "disabilityDeterminationSourceTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisabilityDeterminationSourceTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDeterminationSourceTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "disabilityDeterminationSourceTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDisabilityDeterminationSourceTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"disabilityDeterminationSourceTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disabilityDeterminationSourceTypeDescriptor" } } }, "required": true, "x-bodyName": "disabilityDeterminationSourceTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "disabilityDeterminationSourceTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisabilityDeterminationSourceTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disabilityDeterminationSourceTypeDescriptors/deletes": { "get": { "tags": [ "disabilityDeterminationSourceTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisabilityDeterminationSourceTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disabilityDeterminationSourceTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disabilityDeterminationSourceTypeDescriptors/keyChanges": { "get": { "tags": [ "disabilityDeterminationSourceTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisabilityDeterminationSourceTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disabilityDeterminationSourceTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disabilityDeterminationSourceTypeDescriptors/partitions": { "get": { "tags": [ "disabilityDeterminationSourceTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisabilityDeterminationSourceTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/disciplineActions": { "get": { "tags": [ "disciplineActions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisciplineActions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "disciplineActionIdentifier", "in": "query", "description": "Identifier assigned by the education organization to the discipline action.", "schema": { "maxLength": 36, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "disciplineDate", "in": "query", "description": "The date of the discipline action.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "responsibilitySchoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "assignmentSchoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "disciplineActionLengthDifferenceReasonDescriptor", "in": "query", "description": "Indicates the reason for the difference, if any, between the official and actual lengths of a student's disciplinary assignment.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "actualDisciplineActionLength", "in": "query", "description": "Indicates the actual length in school days of a student's disciplinary assignment.", "schema": { "type": "number", "format": "double" } }, { "name": "disciplineActionLength", "in": "query", "description": "The length of time in school days for the discipline action (e.g. removal, detention), if applicable.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "iepPlacementMeetingIndicator", "in": "query", "description": "An indication as to whether an offense and/or disciplinary action resulted in a meeting of a student's Individualized Education Program (IEP) team to determine appropriate placement.", "schema": { "type": "boolean" } }, { "name": "relatedToZeroTolerancePolicy", "in": "query", "description": "An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies.", "schema": { "type": "boolean" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_disciplineAction" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "disciplineActions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisciplineAction", "requestBody": { "description": "The JSON representation of the \"disciplineAction\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineAction" } } }, "required": true, "x-bodyName": "disciplineAction" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineActions/{id}": { "get": { "tags": [ "disciplineActions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisciplineActionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineAction" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "disciplineActions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"disciplineAction\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineAction" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "disciplineActions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisciplineActionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineActions/deletes": { "get": { "tags": [ "disciplineActions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisciplineActions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineActionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineActions/keyChanges": { "get": { "tags": [ "disciplineActions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisciplineActions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineActionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineActions/partitions": { "get": { "tags": [ "disciplineActions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisciplineActionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "disciplineActionIdentifier", "in": "query", "description": "Identifier assigned by the education organization to the discipline action.", "schema": { "maxLength": 36, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "disciplineDate", "in": "query", "description": "The date of the discipline action.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "responsibilitySchoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "assignmentSchoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "disciplineActionLengthDifferenceReasonDescriptor", "in": "query", "description": "Indicates the reason for the difference, if any, between the official and actual lengths of a student's disciplinary assignment.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "actualDisciplineActionLength", "in": "query", "description": "Indicates the actual length in school days of a student's disciplinary assignment.", "schema": { "type": "number", "format": "double" } }, { "name": "disciplineActionLength", "in": "query", "description": "The length of time in school days for the discipline action (e.g. removal, detention), if applicable.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "iepPlacementMeetingIndicator", "in": "query", "description": "An indication as to whether an offense and/or disciplinary action resulted in a meeting of a student's Individualized Education Program (IEP) team to determine appropriate placement.", "schema": { "type": "boolean" } }, { "name": "relatedToZeroTolerancePolicy", "in": "query", "description": "An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies.", "schema": { "type": "boolean" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors": { "get": { "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisciplineActionLengthDifferenceReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_disciplineActionLengthDifferenceReasonDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisciplineActionLengthDifferenceReasonDescriptor", "requestBody": { "description": "The JSON representation of the \"disciplineActionLengthDifferenceReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineActionLengthDifferenceReasonDescriptor" } } }, "required": true, "x-bodyName": "disciplineActionLengthDifferenceReasonDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { "get": { "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisciplineActionLengthDifferenceReasonDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineActionLengthDifferenceReasonDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDisciplineActionLengthDifferenceReasonDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"disciplineActionLengthDifferenceReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineActionLengthDifferenceReasonDescriptor" } } }, "required": true, "x-bodyName": "disciplineActionLengthDifferenceReasonDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisciplineActionLengthDifferenceReasonDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/deletes": { "get": { "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisciplineActionLengthDifferenceReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineActionLengthDifferenceReasonDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/keyChanges": { "get": { "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisciplineActionLengthDifferenceReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineActionLengthDifferenceReasonDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/partitions": { "get": { "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisciplineActionLengthDifferenceReasonDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/disciplineDescriptors": { "get": { "tags": [ "disciplineDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisciplineDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_disciplineDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "disciplineDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisciplineDescriptor", "requestBody": { "description": "The JSON representation of the \"disciplineDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineDescriptor" } } }, "required": true, "x-bodyName": "disciplineDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineDescriptors/{id}": { "get": { "tags": [ "disciplineDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisciplineDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "disciplineDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDisciplineDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"disciplineDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineDescriptor" } } }, "required": true, "x-bodyName": "disciplineDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "disciplineDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisciplineDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineDescriptors/deletes": { "get": { "tags": [ "disciplineDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisciplineDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineDescriptors/keyChanges": { "get": { "tags": [ "disciplineDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisciplineDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineDescriptors/partitions": { "get": { "tags": [ "disciplineDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisciplineDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/disciplineIncidents": { "get": { "tags": [ "disciplineIncidents" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisciplineIncidents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "incidentIdentifier", "in": "query", "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire discipline incident even if it included multiple offenses and multiple offenders.", "schema": { "maxLength": 36, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "incidentLocationDescriptor", "in": "query", "description": "Identifies where the discipline incident occurred and whether or not it occurred on school.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "reporterDescriptionDescriptor", "in": "query", "description": "Information on the type of individual who reported the discipline incident. When known and/or if useful, use a more specific option code (e.g., \"Counselor\" rather than \"Professional Staff\").", "schema": { "maxLength": 306, "type": "string" } }, { "name": "caseNumber", "in": "query", "description": "The case number assigned to the DisciplineIncident by law enforcement or other organization.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "incidentCost", "in": "query", "description": "The value of any quantifiable monetary loss directly resulting from the discipline incident. Examples include the value of repairs necessitated by vandalism of a school facility, or the value of personnel resources used for repairs or consumed by the incident.", "schema": { "type": "number", "format": "double" } }, { "name": "incidentDate", "in": "query", "description": "The month, day, and year on which the discipline incident occurred.", "schema": { "type": "string", "format": "date" } }, { "name": "incidentDescription", "in": "query", "description": "The description for an incident.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "incidentTime", "in": "query", "description": "An indication of the time of day the incident took place.", "schema": { "type": "string" } }, { "name": "reportedToLawEnforcement", "in": "query", "description": "Indicator of whether the incident was reported to law enforcement.", "schema": { "type": "boolean" } }, { "name": "reporterName", "in": "query", "description": "Identifies the reporter of the discipline incident by name.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_disciplineIncident" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "disciplineIncidents" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisciplineIncident", "requestBody": { "description": "The JSON representation of the \"disciplineIncident\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineIncident" } } }, "required": true, "x-bodyName": "disciplineIncident" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineIncidents/{id}": { "get": { "tags": [ "disciplineIncidents" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisciplineIncidentsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineIncident" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "disciplineIncidents" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"disciplineIncident\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineIncident" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "disciplineIncidents" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisciplineIncidentById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineIncidents/deletes": { "get": { "tags": [ "disciplineIncidents" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisciplineIncidents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineIncidentDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineIncidents/keyChanges": { "get": { "tags": [ "disciplineIncidents" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisciplineIncidents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineIncidentKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineIncidents/partitions": { "get": { "tags": [ "disciplineIncidents" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisciplineIncidentsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "incidentIdentifier", "in": "query", "description": "A locally assigned unique identifier (within the school or school district) to identify each specific DisciplineIncident or occurrence. The same identifier should be used to document the entire discipline incident even if it included multiple offenses and multiple offenders.", "schema": { "maxLength": 36, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "incidentLocationDescriptor", "in": "query", "description": "Identifies where the discipline incident occurred and whether or not it occurred on school.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "reporterDescriptionDescriptor", "in": "query", "description": "Information on the type of individual who reported the discipline incident. When known and/or if useful, use a more specific option code (e.g., \"Counselor\" rather than \"Professional Staff\").", "schema": { "maxLength": 306, "type": "string" } }, { "name": "caseNumber", "in": "query", "description": "The case number assigned to the DisciplineIncident by law enforcement or other organization.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "incidentCost", "in": "query", "description": "The value of any quantifiable monetary loss directly resulting from the discipline incident. Examples include the value of repairs necessitated by vandalism of a school facility, or the value of personnel resources used for repairs or consumed by the incident.", "schema": { "type": "number", "format": "double" } }, { "name": "incidentDate", "in": "query", "description": "The month, day, and year on which the discipline incident occurred.", "schema": { "type": "string", "format": "date" } }, { "name": "incidentDescription", "in": "query", "description": "The description for an incident.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "incidentTime", "in": "query", "description": "An indication of the time of day the incident took place.", "schema": { "type": "string" } }, { "name": "reportedToLawEnforcement", "in": "query", "description": "Indicator of whether the incident was reported to law enforcement.", "schema": { "type": "boolean" } }, { "name": "reporterName", "in": "query", "description": "Identifies the reporter of the discipline incident by name.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/disciplineIncidentParticipationCodeDescriptors": { "get": { "tags": [ "disciplineIncidentParticipationCodeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisciplineIncidentParticipationCodeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_disciplineIncidentParticipationCodeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "disciplineIncidentParticipationCodeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisciplineIncidentParticipationCodeDescriptor", "requestBody": { "description": "The JSON representation of the \"disciplineIncidentParticipationCodeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineIncidentParticipationCodeDescriptor" } } }, "required": true, "x-bodyName": "disciplineIncidentParticipationCodeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { "get": { "tags": [ "disciplineIncidentParticipationCodeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisciplineIncidentParticipationCodeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineIncidentParticipationCodeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "disciplineIncidentParticipationCodeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDisciplineIncidentParticipationCodeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"disciplineIncidentParticipationCodeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_disciplineIncidentParticipationCodeDescriptor" } } }, "required": true, "x-bodyName": "disciplineIncidentParticipationCodeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "disciplineIncidentParticipationCodeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisciplineIncidentParticipationCodeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/disciplineIncidentParticipationCodeDescriptors/deletes": { "get": { "tags": [ "disciplineIncidentParticipationCodeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisciplineIncidentParticipationCodeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineIncidentParticipationCodeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineIncidentParticipationCodeDescriptors/keyChanges": { "get": { "tags": [ "disciplineIncidentParticipationCodeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisciplineIncidentParticipationCodeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_disciplineIncidentParticipationCodeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/disciplineIncidentParticipationCodeDescriptors/partitions": { "get": { "tags": [ "disciplineIncidentParticipationCodeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisciplineIncidentParticipationCodeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/displacedStudentStatusDescriptors": { "get": { "tags": [ "displacedStudentStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDisplacedStudentStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_displacedStudentStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "displacedStudentStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDisplacedStudentStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"displacedStudentStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_displacedStudentStatusDescriptor" } } }, "required": true, "x-bodyName": "displacedStudentStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/displacedStudentStatusDescriptors/{id}": { "get": { "tags": [ "displacedStudentStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDisplacedStudentStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_displacedStudentStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "displacedStudentStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDisplacedStudentStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"displacedStudentStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_displacedStudentStatusDescriptor" } } }, "required": true, "x-bodyName": "displacedStudentStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "displacedStudentStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDisplacedStudentStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/displacedStudentStatusDescriptors/deletes": { "get": { "tags": [ "displacedStudentStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDisplacedStudentStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_displacedStudentStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/displacedStudentStatusDescriptors/keyChanges": { "get": { "tags": [ "displacedStudentStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDisplacedStudentStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_displacedStudentStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/displacedStudentStatusDescriptors/partitions": { "get": { "tags": [ "displacedStudentStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDisplacedStudentStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/dualCreditInstitutionDescriptors": { "get": { "tags": [ "dualCreditInstitutionDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDualCreditInstitutionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_dualCreditInstitutionDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "dualCreditInstitutionDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDualCreditInstitutionDescriptor", "requestBody": { "description": "The JSON representation of the \"dualCreditInstitutionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_dualCreditInstitutionDescriptor" } } }, "required": true, "x-bodyName": "dualCreditInstitutionDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/dualCreditInstitutionDescriptors/{id}": { "get": { "tags": [ "dualCreditInstitutionDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDualCreditInstitutionDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_dualCreditInstitutionDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "dualCreditInstitutionDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDualCreditInstitutionDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"dualCreditInstitutionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_dualCreditInstitutionDescriptor" } } }, "required": true, "x-bodyName": "dualCreditInstitutionDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "dualCreditInstitutionDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDualCreditInstitutionDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/dualCreditInstitutionDescriptors/deletes": { "get": { "tags": [ "dualCreditInstitutionDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDualCreditInstitutionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_dualCreditInstitutionDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/dualCreditInstitutionDescriptors/keyChanges": { "get": { "tags": [ "dualCreditInstitutionDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDualCreditInstitutionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_dualCreditInstitutionDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/dualCreditInstitutionDescriptors/partitions": { "get": { "tags": [ "dualCreditInstitutionDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDualCreditInstitutionDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/dualCreditTypeDescriptors": { "get": { "tags": [ "dualCreditTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getDualCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_dualCreditTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "dualCreditTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postDualCreditTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"dualCreditTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_dualCreditTypeDescriptor" } } }, "required": true, "x-bodyName": "dualCreditTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/dualCreditTypeDescriptors/{id}": { "get": { "tags": [ "dualCreditTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getDualCreditTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_dualCreditTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "dualCreditTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putDualCreditTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"dualCreditTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_dualCreditTypeDescriptor" } } }, "required": true, "x-bodyName": "dualCreditTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "dualCreditTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteDualCreditTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/dualCreditTypeDescriptors/deletes": { "get": { "tags": [ "dualCreditTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesDualCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_dualCreditTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/dualCreditTypeDescriptors/keyChanges": { "get": { "tags": [ "dualCreditTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesDualCreditTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_dualCreditTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/dualCreditTypeDescriptors/partitions": { "get": { "tags": [ "dualCreditTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getDualCreditTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationalEnvironmentDescriptors": { "get": { "tags": [ "educationalEnvironmentDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationalEnvironmentDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationalEnvironmentDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationalEnvironmentDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationalEnvironmentDescriptor", "requestBody": { "description": "The JSON representation of the \"educationalEnvironmentDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationalEnvironmentDescriptor" } } }, "required": true, "x-bodyName": "educationalEnvironmentDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationalEnvironmentDescriptors/{id}": { "get": { "tags": [ "educationalEnvironmentDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationalEnvironmentDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationalEnvironmentDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationalEnvironmentDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEducationalEnvironmentDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationalEnvironmentDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationalEnvironmentDescriptor" } } }, "required": true, "x-bodyName": "educationalEnvironmentDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationalEnvironmentDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationalEnvironmentDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationalEnvironmentDescriptors/deletes": { "get": { "tags": [ "educationalEnvironmentDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationalEnvironmentDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationalEnvironmentDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationalEnvironmentDescriptors/keyChanges": { "get": { "tags": [ "educationalEnvironmentDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationalEnvironmentDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationalEnvironmentDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationalEnvironmentDescriptors/partitions": { "get": { "tags": [ "educationalEnvironmentDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationalEnvironmentDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationContents": { "get": { "tags": [ "educationContents" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationContents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "contentIdentifier", "in": "query", "description": "A unique identifier for the education content.", "schema": { "maxLength": 225, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "learningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "contentClassDescriptor", "in": "query", "description": "The predominate type or kind characterizing the learning resource.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "costRateDescriptor", "in": "query", "description": "The rate by which the cost applies.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "interactivityStyleDescriptor", "in": "query", "description": "The predominate mode of learning supported by the learning resource. Acceptable values are active, expositive, or mixed.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "additionalAuthorsIndicator", "in": "query", "description": "Indicates whether there are additional un-named authors. In a research report, this is often marked by the abbreviation \"et al\".", "schema": { "type": "boolean" } }, { "name": "cost", "in": "query", "description": "An amount that has to be paid or spent to buy or obtain the education content.", "schema": { "type": "number", "format": "double" } }, { "name": "description", "in": "query", "description": "An extended written representation of the education content.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "learningResourceMetadataURI", "in": "query", "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "namespace", "in": "query", "description": "Namespace for the education content.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "publicationDate", "in": "query", "description": "The date on which this content was first published.", "schema": { "type": "string", "format": "date" } }, { "name": "publicationYear", "in": "query", "description": "The year at which this content was first published.", "schema": { "type": "integer", "format": "int32" } }, { "name": "publisher", "in": "query", "description": "The organization credited with publishing the resource.", "schema": { "maxLength": 50, "type": "string" } }, { "name": "shortDescription", "in": "query", "description": "A short description or name of the entity.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "timeRequired", "in": "query", "description": "Approximate or typical time that it takes to work with or through this learning resource for the typical intended target audience expressed in minutes.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "useRightsURL", "in": "query", "description": "The URL where the owner specifies permissions for using the resource.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "version", "in": "query", "description": "The version identifier for the content.", "schema": { "maxLength": 10, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationContent" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationContents" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationContent", "requestBody": { "description": "The JSON representation of the \"educationContent\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationContent" } } }, "required": true, "x-bodyName": "educationContent" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationContents/{id}": { "get": { "tags": [ "educationContents" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationContentsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationContent" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationContents" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationContent\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationContent" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationContents" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationContentById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationContents/deletes": { "get": { "tags": [ "educationContents" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationContents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationContentDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationContents/keyChanges": { "get": { "tags": [ "educationContents" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationContents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationContentKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationContents/partitions": { "get": { "tags": [ "educationContents" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationContentsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "contentIdentifier", "in": "query", "description": "A unique identifier for the education content.", "schema": { "maxLength": 225, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "learningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "contentClassDescriptor", "in": "query", "description": "The predominate type or kind characterizing the learning resource.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "costRateDescriptor", "in": "query", "description": "The rate by which the cost applies.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "interactivityStyleDescriptor", "in": "query", "description": "The predominate mode of learning supported by the learning resource. Acceptable values are active, expositive, or mixed.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "additionalAuthorsIndicator", "in": "query", "description": "Indicates whether there are additional un-named authors. In a research report, this is often marked by the abbreviation \"et al\".", "schema": { "type": "boolean" } }, { "name": "cost", "in": "query", "description": "An amount that has to be paid or spent to buy or obtain the education content.", "schema": { "type": "number", "format": "double" } }, { "name": "description", "in": "query", "description": "An extended written representation of the education content.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "learningResourceMetadataURI", "in": "query", "description": "The URI (typical a URL) pointing to the metadata entry in a LRMI metadata repository, which describes this content item.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "namespace", "in": "query", "description": "Namespace for the education content.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "publicationDate", "in": "query", "description": "The date on which this content was first published.", "schema": { "type": "string", "format": "date" } }, { "name": "publicationYear", "in": "query", "description": "The year at which this content was first published.", "schema": { "type": "integer", "format": "int32" } }, { "name": "publisher", "in": "query", "description": "The organization credited with publishing the resource.", "schema": { "maxLength": 50, "type": "string" } }, { "name": "shortDescription", "in": "query", "description": "A short description or name of the entity.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "timeRequired", "in": "query", "description": "Approximate or typical time that it takes to work with or through this learning resource for the typical intended target audience expressed in minutes.", "schema": { "maxLength": 30, "type": "string" } }, { "name": "useRightsURL", "in": "query", "description": "The URL where the owner specifies permissions for using the resource.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "version", "in": "query", "description": "The version identifier for the content.", "schema": { "maxLength": 10, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationOrganizationAssociationTypeDescriptors": { "get": { "tags": [ "educationOrganizationAssociationTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationOrganizationAssociationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationOrganizationAssociationTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationOrganizationAssociationTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationOrganizationAssociationTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"educationOrganizationAssociationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationAssociationTypeDescriptor" } } }, "required": true, "x-bodyName": "educationOrganizationAssociationTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { "get": { "tags": [ "educationOrganizationAssociationTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationOrganizationAssociationTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationAssociationTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationOrganizationAssociationTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEducationOrganizationAssociationTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationOrganizationAssociationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationAssociationTypeDescriptor" } } }, "required": true, "x-bodyName": "educationOrganizationAssociationTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationOrganizationAssociationTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationOrganizationAssociationTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationAssociationTypeDescriptors/deletes": { "get": { "tags": [ "educationOrganizationAssociationTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationOrganizationAssociationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationAssociationTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationAssociationTypeDescriptors/keyChanges": { "get": { "tags": [ "educationOrganizationAssociationTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationOrganizationAssociationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationAssociationTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationAssociationTypeDescriptors/partitions": { "get": { "tags": [ "educationOrganizationAssociationTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationOrganizationAssociationTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationOrganizationCategoryDescriptors": { "get": { "tags": [ "educationOrganizationCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationOrganizationCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationOrganizationCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationOrganizationCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationOrganizationCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"educationOrganizationCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationCategoryDescriptor" } } }, "required": true, "x-bodyName": "educationOrganizationCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { "get": { "tags": [ "educationOrganizationCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationOrganizationCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationOrganizationCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEducationOrganizationCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationOrganizationCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationCategoryDescriptor" } } }, "required": true, "x-bodyName": "educationOrganizationCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationOrganizationCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationOrganizationCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationCategoryDescriptors/deletes": { "get": { "tags": [ "educationOrganizationCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationOrganizationCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationCategoryDescriptors/keyChanges": { "get": { "tags": [ "educationOrganizationCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationOrganizationCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationCategoryDescriptors/partitions": { "get": { "tags": [ "educationOrganizationCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationOrganizationCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationOrganizationIdentificationSystemDescriptors": { "get": { "tags": [ "educationOrganizationIdentificationSystemDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationOrganizationIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationOrganizationIdentificationSystemDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationOrganizationIdentificationSystemDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationOrganizationIdentificationSystemDescriptor", "requestBody": { "description": "The JSON representation of the \"educationOrganizationIdentificationSystemDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationIdentificationSystemDescriptor" } } }, "required": true, "x-bodyName": "educationOrganizationIdentificationSystemDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { "get": { "tags": [ "educationOrganizationIdentificationSystemDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationOrganizationIdentificationSystemDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationIdentificationSystemDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationOrganizationIdentificationSystemDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEducationOrganizationIdentificationSystemDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationOrganizationIdentificationSystemDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationIdentificationSystemDescriptor" } } }, "required": true, "x-bodyName": "educationOrganizationIdentificationSystemDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationOrganizationIdentificationSystemDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationOrganizationIdentificationSystemDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationIdentificationSystemDescriptors/deletes": { "get": { "tags": [ "educationOrganizationIdentificationSystemDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationOrganizationIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationIdentificationSystemDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationIdentificationSystemDescriptors/keyChanges": { "get": { "tags": [ "educationOrganizationIdentificationSystemDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationOrganizationIdentificationSystemDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationIdentificationSystemDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationIdentificationSystemDescriptors/partitions": { "get": { "tags": [ "educationOrganizationIdentificationSystemDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationOrganizationIdentificationSystemDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationOrganizationInterventionPrescriptionAssociations": { "get": { "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationOrganizationInterventionPrescriptionAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "interventionPrescriptionEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "interventionPrescriptionIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention prescription.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "The begin date of the period during which the intervention prescription is available. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The end date of the period during which the intervention prescription is available. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationOrganizationInterventionPrescriptionAssociation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationOrganizationInterventionPrescriptionAssociation", "requestBody": { "description": "The JSON representation of the \"educationOrganizationInterventionPrescriptionAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationInterventionPrescriptionAssociation" } } }, "required": true, "x-bodyName": "educationOrganizationInterventionPrescriptionAssociation" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { "get": { "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationInterventionPrescriptionAssociation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationOrganizationInterventionPrescriptionAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationInterventionPrescriptionAssociation" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationOrganizationInterventionPrescriptionAssociationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/deletes": { "get": { "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationOrganizationInterventionPrescriptionAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationInterventionPrescriptionAssociationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/keyChanges": { "get": { "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationOrganizationInterventionPrescriptionAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationInterventionPrescriptionAssociationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/partitions": { "get": { "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "interventionPrescriptionEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "interventionPrescriptionIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention prescription.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "The begin date of the period during which the intervention prescription is available. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The end date of the period during which the intervention prescription is available. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationOrganizationNetworks": { "get": { "tags": [ "educationOrganizationNetworks" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationOrganizationNetworks", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "educationOrganizationNetworkId", "in": "query", "description": "The identifier assigned to a network of education organizations. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "networkPurposeDescriptor", "in": "query", "description": "The purpose(s) of the network (e.g., shared services, collective procurement).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationOrganizationNetwork" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationOrganizationNetworks" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationOrganizationNetwork", "requestBody": { "description": "The JSON representation of the \"educationOrganizationNetwork\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationNetwork" } } }, "required": true, "x-bodyName": "educationOrganizationNetwork" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationNetworks/{id}": { "get": { "tags": [ "educationOrganizationNetworks" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationOrganizationNetworksById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationNetwork" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationOrganizationNetworks" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationOrganizationNetwork\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationNetwork" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationOrganizationNetworks" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationOrganizationNetworkById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationNetworks/deletes": { "get": { "tags": [ "educationOrganizationNetworks" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationOrganizationNetworks", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationNetworkDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationNetworks/keyChanges": { "get": { "tags": [ "educationOrganizationNetworks" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationOrganizationNetworks", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationNetworkKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationNetworks/partitions": { "get": { "tags": [ "educationOrganizationNetworks" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationOrganizationNetworksPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "educationOrganizationNetworkId", "in": "query", "description": "The identifier assigned to a network of education organizations. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "networkPurposeDescriptor", "in": "query", "description": "The purpose(s) of the network (e.g., shared services, collective procurement).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationOrganizationNetworkAssociations": { "get": { "tags": [ "educationOrganizationNetworkAssociations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationOrganizationNetworkAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "memberEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationNetworkId", "in": "query", "description": "The identifier assigned to a network of education organizations. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "The date on which the education organization joined this network. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The date on which the education organization left this network. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationOrganizationNetworkAssociation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationOrganizationNetworkAssociations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationOrganizationNetworkAssociation", "requestBody": { "description": "The JSON representation of the \"educationOrganizationNetworkAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationNetworkAssociation" } } }, "required": true, "x-bodyName": "educationOrganizationNetworkAssociation" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationNetworkAssociations/{id}": { "get": { "tags": [ "educationOrganizationNetworkAssociations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationOrganizationNetworkAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationNetworkAssociation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationOrganizationNetworkAssociations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationOrganizationNetworkAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationNetworkAssociation" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationOrganizationNetworkAssociations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationOrganizationNetworkAssociationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationNetworkAssociations/deletes": { "get": { "tags": [ "educationOrganizationNetworkAssociations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationOrganizationNetworkAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationNetworkAssociationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationNetworkAssociations/keyChanges": { "get": { "tags": [ "educationOrganizationNetworkAssociations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationOrganizationNetworkAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationNetworkAssociationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationNetworkAssociations/partitions": { "get": { "tags": [ "educationOrganizationNetworkAssociations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationOrganizationNetworkAssociationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "memberEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationNetworkId", "in": "query", "description": "The identifier assigned to a network of education organizations. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "The date on which the education organization joined this network. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The date on which the education organization left this network. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationOrganizationPeerAssociations": { "get": { "tags": [ "educationOrganizationPeerAssociations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationOrganizationPeerAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "peerEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationOrganizationPeerAssociation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationOrganizationPeerAssociations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationOrganizationPeerAssociation", "requestBody": { "description": "The JSON representation of the \"educationOrganizationPeerAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationPeerAssociation" } } }, "required": true, "x-bodyName": "educationOrganizationPeerAssociation" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationPeerAssociations/{id}": { "get": { "tags": [ "educationOrganizationPeerAssociations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationOrganizationPeerAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationPeerAssociation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationOrganizationPeerAssociations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationOrganizationPeerAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationOrganizationPeerAssociation" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationOrganizationPeerAssociations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationOrganizationPeerAssociationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationOrganizationPeerAssociations/deletes": { "get": { "tags": [ "educationOrganizationPeerAssociations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationOrganizationPeerAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationPeerAssociationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationPeerAssociations/keyChanges": { "get": { "tags": [ "educationOrganizationPeerAssociations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationOrganizationPeerAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationOrganizationPeerAssociationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationOrganizationPeerAssociations/partitions": { "get": { "tags": [ "educationOrganizationPeerAssociations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationOrganizationPeerAssociationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "peerEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationPlanDescriptors": { "get": { "tags": [ "educationPlanDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationPlanDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationPlanDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationPlanDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationPlanDescriptor", "requestBody": { "description": "The JSON representation of the \"educationPlanDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationPlanDescriptor" } } }, "required": true, "x-bodyName": "educationPlanDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationPlanDescriptors/{id}": { "get": { "tags": [ "educationPlanDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationPlanDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationPlanDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationPlanDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEducationPlanDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationPlanDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationPlanDescriptor" } } }, "required": true, "x-bodyName": "educationPlanDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationPlanDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationPlanDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationPlanDescriptors/deletes": { "get": { "tags": [ "educationPlanDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationPlanDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationPlanDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationPlanDescriptors/keyChanges": { "get": { "tags": [ "educationPlanDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationPlanDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationPlanDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationPlanDescriptors/partitions": { "get": { "tags": [ "educationPlanDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationPlanDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/educationServiceCenters": { "get": { "tags": [ "educationServiceCenters" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducationServiceCenters", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "educationServiceCenterId", "in": "query", "description": "The identifier assigned to an education service center. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "stateEducationAgencyId", "in": "query", "description": "The identifier assigned to a state education agency. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_educationServiceCenter" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educationServiceCenters" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducationServiceCenter", "requestBody": { "description": "The JSON representation of the \"educationServiceCenter\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationServiceCenter" } } }, "required": true, "x-bodyName": "educationServiceCenter" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationServiceCenters/{id}": { "get": { "tags": [ "educationServiceCenters" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducationServiceCentersById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationServiceCenter" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educationServiceCenters" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educationServiceCenter\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_educationServiceCenter" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educationServiceCenters" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducationServiceCenterById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/educationServiceCenters/deletes": { "get": { "tags": [ "educationServiceCenters" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducationServiceCenters", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationServiceCenterDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationServiceCenters/keyChanges": { "get": { "tags": [ "educationServiceCenters" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducationServiceCenters", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_educationServiceCenterKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/educationServiceCenters/partitions": { "get": { "tags": [ "educationServiceCenters" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducationServiceCentersPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "educationServiceCenterId", "in": "query", "description": "The identifier assigned to an education service center. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "stateEducationAgencyId", "in": "query", "description": "The identifier assigned to a state education agency. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/educatorPreparationPrograms": { "get": { "tags": [ "educatorPreparationPrograms" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducatorPreparationPrograms", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "programTypeDescriptor", "in": "query", "description": "The type of program.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programName", "in": "query", "description": "The name of the Educator Preparation Program.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "accreditationStatusDescriptor", "in": "query", "description": "The current accreditation status of the Educator Preparation Program.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "programId", "in": "query", "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_educatorPreparationProgram" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educatorPreparationPrograms" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducatorPreparationProgram", "requestBody": { "description": "The JSON representation of the \"educatorPreparationProgram\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_educatorPreparationProgram" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/educatorPreparationPrograms/{id}": { "get": { "tags": [ "educatorPreparationPrograms" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducatorPreparationProgramsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_educatorPreparationProgram" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educatorPreparationPrograms" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEducatorPreparationProgram", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educatorPreparationProgram\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_educatorPreparationProgram" } } }, "required": true, "x-bodyName": "educatorPreparationProgram" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educatorPreparationPrograms" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducatorPreparationProgramById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/educatorPreparationPrograms/deletes": { "get": { "tags": [ "educatorPreparationPrograms" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducatorPreparationPrograms", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_educatorPreparationProgramDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/educatorPreparationPrograms/keyChanges": { "get": { "tags": [ "educatorPreparationPrograms" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducatorPreparationPrograms", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_educatorPreparationProgramKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/educatorPreparationPrograms/partitions": { "get": { "tags": [ "educatorPreparationPrograms" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducatorPreparationProgramsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "programTypeDescriptor", "in": "query", "description": "The type of program.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programName", "in": "query", "description": "The name of the Educator Preparation Program.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "accreditationStatusDescriptor", "in": "query", "description": "The current accreditation status of the Educator Preparation Program.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "programId", "in": "query", "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/educatorRoleDescriptors": { "get": { "tags": [ "educatorRoleDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEducatorRoleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_educatorRoleDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "educatorRoleDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEducatorRoleDescriptor", "requestBody": { "description": "The JSON representation of the \"educatorRoleDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_educatorRoleDescriptor" } } }, "required": true, "x-bodyName": "educatorRoleDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/educatorRoleDescriptors/{id}": { "get": { "tags": [ "educatorRoleDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEducatorRoleDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_educatorRoleDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "educatorRoleDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEducatorRoleDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"educatorRoleDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_educatorRoleDescriptor" } } }, "required": true, "x-bodyName": "educatorRoleDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "educatorRoleDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEducatorRoleDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/educatorRoleDescriptors/deletes": { "get": { "tags": [ "educatorRoleDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEducatorRoleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_educatorRoleDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/educatorRoleDescriptors/keyChanges": { "get": { "tags": [ "educatorRoleDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEducatorRoleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_educatorRoleDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/educatorRoleDescriptors/partitions": { "get": { "tags": [ "educatorRoleDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEducatorRoleDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/electronicMailTypeDescriptors": { "get": { "tags": [ "electronicMailTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getElectronicMailTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_electronicMailTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "electronicMailTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postElectronicMailTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"electronicMailTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_electronicMailTypeDescriptor" } } }, "required": true, "x-bodyName": "electronicMailTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/electronicMailTypeDescriptors/{id}": { "get": { "tags": [ "electronicMailTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getElectronicMailTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_electronicMailTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "electronicMailTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putElectronicMailTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"electronicMailTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_electronicMailTypeDescriptor" } } }, "required": true, "x-bodyName": "electronicMailTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "electronicMailTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteElectronicMailTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/electronicMailTypeDescriptors/deletes": { "get": { "tags": [ "electronicMailTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesElectronicMailTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_electronicMailTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/electronicMailTypeDescriptors/keyChanges": { "get": { "tags": [ "electronicMailTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesElectronicMailTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_electronicMailTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/electronicMailTypeDescriptors/partitions": { "get": { "tags": [ "electronicMailTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getElectronicMailTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/eligibilityDelayReasonDescriptors": { "get": { "tags": [ "eligibilityDelayReasonDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEligibilityDelayReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_eligibilityDelayReasonDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "eligibilityDelayReasonDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEligibilityDelayReasonDescriptor", "requestBody": { "description": "The JSON representation of the \"eligibilityDelayReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eligibilityDelayReasonDescriptor" } } }, "required": true, "x-bodyName": "eligibilityDelayReasonDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { "get": { "tags": [ "eligibilityDelayReasonDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEligibilityDelayReasonDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eligibilityDelayReasonDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "eligibilityDelayReasonDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEligibilityDelayReasonDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"eligibilityDelayReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eligibilityDelayReasonDescriptor" } } }, "required": true, "x-bodyName": "eligibilityDelayReasonDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "eligibilityDelayReasonDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEligibilityDelayReasonDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/eligibilityDelayReasonDescriptors/deletes": { "get": { "tags": [ "eligibilityDelayReasonDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEligibilityDelayReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_eligibilityDelayReasonDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/eligibilityDelayReasonDescriptors/keyChanges": { "get": { "tags": [ "eligibilityDelayReasonDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEligibilityDelayReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_eligibilityDelayReasonDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/eligibilityDelayReasonDescriptors/partitions": { "get": { "tags": [ "eligibilityDelayReasonDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEligibilityDelayReasonDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/eligibilityEvaluationTypeDescriptors": { "get": { "tags": [ "eligibilityEvaluationTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEligibilityEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_eligibilityEvaluationTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "eligibilityEvaluationTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEligibilityEvaluationTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"eligibilityEvaluationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eligibilityEvaluationTypeDescriptor" } } }, "required": true, "x-bodyName": "eligibilityEvaluationTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { "get": { "tags": [ "eligibilityEvaluationTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEligibilityEvaluationTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eligibilityEvaluationTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "eligibilityEvaluationTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEligibilityEvaluationTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"eligibilityEvaluationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eligibilityEvaluationTypeDescriptor" } } }, "required": true, "x-bodyName": "eligibilityEvaluationTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "eligibilityEvaluationTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEligibilityEvaluationTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/eligibilityEvaluationTypeDescriptors/deletes": { "get": { "tags": [ "eligibilityEvaluationTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEligibilityEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_eligibilityEvaluationTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/eligibilityEvaluationTypeDescriptors/keyChanges": { "get": { "tags": [ "eligibilityEvaluationTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEligibilityEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_eligibilityEvaluationTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/eligibilityEvaluationTypeDescriptors/partitions": { "get": { "tags": [ "eligibilityEvaluationTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEligibilityEvaluationTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/employmentStatusDescriptors": { "get": { "tags": [ "employmentStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEmploymentStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_employmentStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "employmentStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEmploymentStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"employmentStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_employmentStatusDescriptor" } } }, "required": true, "x-bodyName": "employmentStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/employmentStatusDescriptors/{id}": { "get": { "tags": [ "employmentStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEmploymentStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_employmentStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "employmentStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEmploymentStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"employmentStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_employmentStatusDescriptor" } } }, "required": true, "x-bodyName": "employmentStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "employmentStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEmploymentStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/employmentStatusDescriptors/deletes": { "get": { "tags": [ "employmentStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEmploymentStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_employmentStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/employmentStatusDescriptors/keyChanges": { "get": { "tags": [ "employmentStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEmploymentStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_employmentStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/employmentStatusDescriptors/partitions": { "get": { "tags": [ "employmentStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEmploymentStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/englishLanguageExamDescriptors": { "get": { "tags": [ "englishLanguageExamDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEnglishLanguageExamDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_englishLanguageExamDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "englishLanguageExamDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEnglishLanguageExamDescriptor", "requestBody": { "description": "The JSON representation of the \"englishLanguageExamDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_englishLanguageExamDescriptor" } } }, "required": true, "x-bodyName": "englishLanguageExamDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/englishLanguageExamDescriptors/{id}": { "get": { "tags": [ "englishLanguageExamDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEnglishLanguageExamDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_englishLanguageExamDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "englishLanguageExamDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEnglishLanguageExamDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"englishLanguageExamDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_englishLanguageExamDescriptor" } } }, "required": true, "x-bodyName": "englishLanguageExamDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "englishLanguageExamDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEnglishLanguageExamDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/englishLanguageExamDescriptors/deletes": { "get": { "tags": [ "englishLanguageExamDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEnglishLanguageExamDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_englishLanguageExamDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/englishLanguageExamDescriptors/keyChanges": { "get": { "tags": [ "englishLanguageExamDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEnglishLanguageExamDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_englishLanguageExamDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/englishLanguageExamDescriptors/partitions": { "get": { "tags": [ "englishLanguageExamDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEnglishLanguageExamDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/enrollmentTypeDescriptors": { "get": { "tags": [ "enrollmentTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEnrollmentTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_enrollmentTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "enrollmentTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEnrollmentTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"enrollmentTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_enrollmentTypeDescriptor" } } }, "required": true, "x-bodyName": "enrollmentTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/enrollmentTypeDescriptors/{id}": { "get": { "tags": [ "enrollmentTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEnrollmentTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_enrollmentTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "enrollmentTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEnrollmentTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"enrollmentTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_enrollmentTypeDescriptor" } } }, "required": true, "x-bodyName": "enrollmentTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "enrollmentTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEnrollmentTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/enrollmentTypeDescriptors/deletes": { "get": { "tags": [ "enrollmentTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEnrollmentTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_enrollmentTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/enrollmentTypeDescriptors/keyChanges": { "get": { "tags": [ "enrollmentTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEnrollmentTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_enrollmentTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/enrollmentTypeDescriptors/partitions": { "get": { "tags": [ "enrollmentTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEnrollmentTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/entryGradeLevelReasonDescriptors": { "get": { "tags": [ "entryGradeLevelReasonDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEntryGradeLevelReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_entryGradeLevelReasonDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "entryGradeLevelReasonDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEntryGradeLevelReasonDescriptor", "requestBody": { "description": "The JSON representation of the \"entryGradeLevelReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_entryGradeLevelReasonDescriptor" } } }, "required": true, "x-bodyName": "entryGradeLevelReasonDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { "get": { "tags": [ "entryGradeLevelReasonDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEntryGradeLevelReasonDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_entryGradeLevelReasonDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "entryGradeLevelReasonDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEntryGradeLevelReasonDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"entryGradeLevelReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_entryGradeLevelReasonDescriptor" } } }, "required": true, "x-bodyName": "entryGradeLevelReasonDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "entryGradeLevelReasonDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEntryGradeLevelReasonDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/entryGradeLevelReasonDescriptors/deletes": { "get": { "tags": [ "entryGradeLevelReasonDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEntryGradeLevelReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_entryGradeLevelReasonDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/entryGradeLevelReasonDescriptors/keyChanges": { "get": { "tags": [ "entryGradeLevelReasonDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEntryGradeLevelReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_entryGradeLevelReasonDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/entryGradeLevelReasonDescriptors/partitions": { "get": { "tags": [ "entryGradeLevelReasonDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEntryGradeLevelReasonDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/entryTypeDescriptors": { "get": { "tags": [ "entryTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEntryTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_entryTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "entryTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEntryTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"entryTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_entryTypeDescriptor" } } }, "required": true, "x-bodyName": "entryTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/entryTypeDescriptors/{id}": { "get": { "tags": [ "entryTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEntryTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_entryTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "entryTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEntryTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"entryTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_entryTypeDescriptor" } } }, "required": true, "x-bodyName": "entryTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "entryTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEntryTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/entryTypeDescriptors/deletes": { "get": { "tags": [ "entryTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEntryTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_entryTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/entryTypeDescriptors/keyChanges": { "get": { "tags": [ "entryTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEntryTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_entryTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/entryTypeDescriptors/partitions": { "get": { "tags": [ "entryTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEntryTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/eppProgramPathwayDescriptors": { "get": { "tags": [ "eppProgramPathwayDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEPPProgramPathwayDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_eppProgramPathwayDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "eppProgramPathwayDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEPPProgramPathwayDescriptor", "requestBody": { "description": "The JSON representation of the \"eppProgramPathwayDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_eppProgramPathwayDescriptor" } } }, "required": true, "x-bodyName": "eppProgramPathwayDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/eppProgramPathwayDescriptors/{id}": { "get": { "tags": [ "eppProgramPathwayDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEPPProgramPathwayDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_eppProgramPathwayDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "eppProgramPathwayDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEPPProgramPathwayDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"eppProgramPathwayDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_eppProgramPathwayDescriptor" } } }, "required": true, "x-bodyName": "eppProgramPathwayDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "eppProgramPathwayDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEPPProgramPathwayDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/eppProgramPathwayDescriptors/deletes": { "get": { "tags": [ "eppProgramPathwayDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEPPProgramPathwayDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_eppProgramPathwayDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/eppProgramPathwayDescriptors/keyChanges": { "get": { "tags": [ "eppProgramPathwayDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEPPProgramPathwayDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_eppProgramPathwayDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/eppProgramPathwayDescriptors/partitions": { "get": { "tags": [ "eppProgramPathwayDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEPPProgramPathwayDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluations": { "get": { "tags": [ "evaluations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTypeDescriptor", "in": "query", "description": "The type of the evaluation (e.g., observation, principal, peer, student survey, student growth).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "evaluationDescription", "in": "query", "description": "The long description of the Evaluation.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "interRaterReliabilityScore", "in": "query", "description": "A score indicating how much homogeneity, or consensus, there is in the ratings given by judges. Most commonly a percentage scale (1-100)", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxRating", "in": "query", "description": "The maximum summary numerical rating or score for the evaluation.", "schema": { "type": "number", "format": "double" } }, { "name": "minRating", "in": "query", "description": "The minimum summary numerical rating or score for the evaluation. If omitted, assumed to be 0.0.", "schema": { "type": "number", "format": "double" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluation", "requestBody": { "description": "The JSON representation of the \"evaluation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluation" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluations/{id}": { "get": { "tags": [ "evaluations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluation", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluation" } } }, "required": true, "x-bodyName": "evaluation" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluations/deletes": { "get": { "tags": [ "evaluations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluations/keyChanges": { "get": { "tags": [ "evaluations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluations/partitions": { "get": { "tags": [ "evaluations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTypeDescriptor", "in": "query", "description": "The type of the evaluation (e.g., observation, principal, peer, student survey, student growth).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "evaluationDescription", "in": "query", "description": "The long description of the Evaluation.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "interRaterReliabilityScore", "in": "query", "description": "A score indicating how much homogeneity, or consensus, there is in the ratings given by judges. Most commonly a percentage scale (1-100)", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxRating", "in": "query", "description": "The maximum summary numerical rating or score for the evaluation.", "schema": { "type": "number", "format": "double" } }, { "name": "minRating", "in": "query", "description": "The minimum summary numerical rating or score for the evaluation. If omitted, assumed to be 0.0.", "schema": { "type": "number", "format": "double" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/evaluationDelayReasonDescriptors": { "get": { "tags": [ "evaluationDelayReasonDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationDelayReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_evaluationDelayReasonDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationDelayReasonDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationDelayReasonDescriptor", "requestBody": { "description": "The JSON representation of the \"evaluationDelayReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_evaluationDelayReasonDescriptor" } } }, "required": true, "x-bodyName": "evaluationDelayReasonDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/evaluationDelayReasonDescriptors/{id}": { "get": { "tags": [ "evaluationDelayReasonDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationDelayReasonDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_evaluationDelayReasonDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationDelayReasonDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationDelayReasonDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationDelayReasonDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_evaluationDelayReasonDescriptor" } } }, "required": true, "x-bodyName": "evaluationDelayReasonDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationDelayReasonDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationDelayReasonDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/evaluationDelayReasonDescriptors/deletes": { "get": { "tags": [ "evaluationDelayReasonDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationDelayReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_evaluationDelayReasonDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/evaluationDelayReasonDescriptors/keyChanges": { "get": { "tags": [ "evaluationDelayReasonDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationDelayReasonDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_evaluationDelayReasonDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/evaluationDelayReasonDescriptors/partitions": { "get": { "tags": [ "evaluationDelayReasonDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationDelayReasonDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationElements": { "get": { "tags": [ "evaluationElements" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationElements", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "evaluationElementTitle", "in": "query", "description": "The name or title of the evaluation element.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationObjectiveTitle", "in": "query", "description": "The name or title of the evaluation Objective.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTypeDescriptor", "in": "query", "description": "The type of the evaluation (e.g., observation, principal, peer, student survey, student growth).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxRating", "in": "query", "description": "The maximum summary numerical rating or score for the evaluation element.", "schema": { "type": "number", "format": "double" } }, { "name": "minRating", "in": "query", "description": "The minimum summary numerical rating or score for the evaluation element. If omitted, assumed to be 0.0.", "schema": { "type": "number", "format": "double" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of this Evaluation Element.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationElement" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationElements" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationElement", "requestBody": { "description": "The JSON representation of the \"evaluationElement\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElement" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationElements/{id}": { "get": { "tags": [ "evaluationElements" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationElementsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElement" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationElements" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationElement", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationElement\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElement" } } }, "required": true, "x-bodyName": "evaluationElement" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationElements" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationElementById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationElements/deletes": { "get": { "tags": [ "evaluationElements" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationElements", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationElementDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationElements/keyChanges": { "get": { "tags": [ "evaluationElements" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationElements", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationElementKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationElements/partitions": { "get": { "tags": [ "evaluationElements" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationElementsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "evaluationElementTitle", "in": "query", "description": "The name or title of the evaluation element.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationObjectiveTitle", "in": "query", "description": "The name or title of the evaluation Objective.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTypeDescriptor", "in": "query", "description": "The type of the evaluation (e.g., observation, principal, peer, student survey, student growth).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxRating", "in": "query", "description": "The maximum summary numerical rating or score for the evaluation element.", "schema": { "type": "number", "format": "double" } }, { "name": "minRating", "in": "query", "description": "The minimum summary numerical rating or score for the evaluation element. If omitted, assumed to be 0.0.", "schema": { "type": "number", "format": "double" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of this Evaluation Element.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationElementRatings": { "get": { "tags": [ "evaluationElementRatings" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationElementRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationElementTitle", "in": "query", "description": "The name or title of the evaluation element.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationObjectiveTitle", "in": "query", "description": "The name or title of the evaluation Objective.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationDate", "in": "query", "description": "The date for the person's evaluation.", "schema": { "type": "string", "format": "date-time" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationElementRatingLevelDescriptor", "in": "query", "description": "The rating level achieved based upon the rating or score.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "areaOfRefinement", "in": "query", "description": "Area identified for person to refine or improve as part of the evaluation.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "areaOfReinforcement", "in": "query", "description": "Area identified for reinforcement or positive feedback as part of the evaluation.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "comments", "in": "query", "description": "Any comments about the performance evaluation to be captured.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "feedback", "in": "query", "description": "Feedback provided to the evaluated person.", "schema": { "maxLength": 2048, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationElementRating" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationElementRatings" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationElementRating", "requestBody": { "description": "The JSON representation of the \"evaluationElementRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElementRating" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationElementRatings/{id}": { "get": { "tags": [ "evaluationElementRatings" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationElementRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElementRating" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationElementRatings" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationElementRating", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationElementRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElementRating" } } }, "required": true, "x-bodyName": "evaluationElementRating" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationElementRatings" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationElementRatingById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationElementRatings/deletes": { "get": { "tags": [ "evaluationElementRatings" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationElementRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationElementRatingDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationElementRatings/keyChanges": { "get": { "tags": [ "evaluationElementRatings" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationElementRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationElementRatingKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationElementRatings/partitions": { "get": { "tags": [ "evaluationElementRatings" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationElementRatingsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationElementTitle", "in": "query", "description": "The name or title of the evaluation element.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationObjectiveTitle", "in": "query", "description": "The name or title of the evaluation Objective.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationDate", "in": "query", "description": "The date for the person's evaluation.", "schema": { "type": "string", "format": "date-time" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationElementRatingLevelDescriptor", "in": "query", "description": "The rating level achieved based upon the rating or score.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "areaOfRefinement", "in": "query", "description": "Area identified for person to refine or improve as part of the evaluation.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "areaOfReinforcement", "in": "query", "description": "Area identified for reinforcement or positive feedback as part of the evaluation.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "comments", "in": "query", "description": "Any comments about the performance evaluation to be captured.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "feedback", "in": "query", "description": "Feedback provided to the evaluated person.", "schema": { "maxLength": 2048, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationElementRatingLevelDescriptors": { "get": { "tags": [ "evaluationElementRatingLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationElementRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationElementRatingLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationElementRatingLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationElementRatingLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"evaluationElementRatingLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElementRatingLevelDescriptor" } } }, "required": true, "x-bodyName": "evaluationElementRatingLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationElementRatingLevelDescriptors/{id}": { "get": { "tags": [ "evaluationElementRatingLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationElementRatingLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElementRatingLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationElementRatingLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationElementRatingLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationElementRatingLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationElementRatingLevelDescriptor" } } }, "required": true, "x-bodyName": "evaluationElementRatingLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationElementRatingLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationElementRatingLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationElementRatingLevelDescriptors/deletes": { "get": { "tags": [ "evaluationElementRatingLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationElementRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationElementRatingLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationElementRatingLevelDescriptors/keyChanges": { "get": { "tags": [ "evaluationElementRatingLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationElementRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationElementRatingLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationElementRatingLevelDescriptors/partitions": { "get": { "tags": [ "evaluationElementRatingLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationElementRatingLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationObjectives": { "get": { "tags": [ "evaluationObjectives" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationObjectives", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "evaluationObjectiveTitle", "in": "query", "description": "The name or title of the evaluation Objective.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTypeDescriptor", "in": "query", "description": "The type of the evaluation Objective (e.g., observation, principal, peer, student survey, student growth).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "evaluationObjectiveDescription", "in": "query", "description": "The long description of the Evaluation Objective.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxRating", "in": "query", "description": "The maximum summary numerical rating or score for the evaluation Objective.", "schema": { "type": "number", "format": "double" } }, { "name": "minRating", "in": "query", "description": "The minimum summary numerical rating or score for the evaluation Objective. If omitted, assumed to be 0.0.", "schema": { "type": "number", "format": "double" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of this Evaluation Objective.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationObjective" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationObjectives" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationObjective", "requestBody": { "description": "The JSON representation of the \"evaluationObjective\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationObjective" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationObjectives/{id}": { "get": { "tags": [ "evaluationObjectives" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationObjectivesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationObjective" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationObjectives" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationObjective", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationObjective\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationObjective" } } }, "required": true, "x-bodyName": "evaluationObjective" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationObjectives" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationObjectiveById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationObjectives/deletes": { "get": { "tags": [ "evaluationObjectives" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationObjectives", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationObjectiveDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationObjectives/keyChanges": { "get": { "tags": [ "evaluationObjectives" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationObjectives", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationObjectiveKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationObjectives/partitions": { "get": { "tags": [ "evaluationObjectives" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationObjectivesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "evaluationObjectiveTitle", "in": "query", "description": "The name or title of the evaluation Objective.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTypeDescriptor", "in": "query", "description": "The type of the evaluation Objective (e.g., observation, principal, peer, student survey, student growth).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "evaluationObjectiveDescription", "in": "query", "description": "The long description of the Evaluation Objective.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxRating", "in": "query", "description": "The maximum summary numerical rating or score for the evaluation Objective.", "schema": { "type": "number", "format": "double" } }, { "name": "minRating", "in": "query", "description": "The minimum summary numerical rating or score for the evaluation Objective. If omitted, assumed to be 0.0.", "schema": { "type": "number", "format": "double" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of this Evaluation Objective.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationObjectiveRatings": { "get": { "tags": [ "evaluationObjectiveRatings" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationObjectiveRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationObjectiveTitle", "in": "query", "description": "The name or title of the evaluation Objective.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationDate", "in": "query", "description": "The date for the person's evaluation.", "schema": { "type": "string", "format": "date-time" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "objectiveRatingLevelDescriptor", "in": "query", "description": "The rating level achieved based upon the rating or score.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "comments", "in": "query", "description": "Any comments about the performance evaluation to be captured.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationObjectiveRating" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationObjectiveRatings" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationObjectiveRating", "requestBody": { "description": "The JSON representation of the \"evaluationObjectiveRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationObjectiveRating" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationObjectiveRatings/{id}": { "get": { "tags": [ "evaluationObjectiveRatings" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationObjectiveRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationObjectiveRating" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationObjectiveRatings" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationObjectiveRating", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationObjectiveRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationObjectiveRating" } } }, "required": true, "x-bodyName": "evaluationObjectiveRating" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationObjectiveRatings" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationObjectiveRatingById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationObjectiveRatings/deletes": { "get": { "tags": [ "evaluationObjectiveRatings" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationObjectiveRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationObjectiveRatingDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationObjectiveRatings/keyChanges": { "get": { "tags": [ "evaluationObjectiveRatings" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationObjectiveRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationObjectiveRatingKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationObjectiveRatings/partitions": { "get": { "tags": [ "evaluationObjectiveRatings" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationObjectiveRatingsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationObjectiveTitle", "in": "query", "description": "The name or title of the evaluation Objective.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationDate", "in": "query", "description": "The date for the person's evaluation.", "schema": { "type": "string", "format": "date-time" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "objectiveRatingLevelDescriptor", "in": "query", "description": "The rating level achieved based upon the rating or score.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "comments", "in": "query", "description": "Any comments about the performance evaluation to be captured.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationPeriodDescriptors": { "get": { "tags": [ "evaluationPeriodDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationPeriodDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationPeriodDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationPeriodDescriptor", "requestBody": { "description": "The JSON representation of the \"evaluationPeriodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationPeriodDescriptor" } } }, "required": true, "x-bodyName": "evaluationPeriodDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationPeriodDescriptors/{id}": { "get": { "tags": [ "evaluationPeriodDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationPeriodDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationPeriodDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationPeriodDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationPeriodDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationPeriodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationPeriodDescriptor" } } }, "required": true, "x-bodyName": "evaluationPeriodDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationPeriodDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationPeriodDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationPeriodDescriptors/deletes": { "get": { "tags": [ "evaluationPeriodDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationPeriodDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationPeriodDescriptors/keyChanges": { "get": { "tags": [ "evaluationPeriodDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationPeriodDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationPeriodDescriptors/partitions": { "get": { "tags": [ "evaluationPeriodDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationPeriodDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationRatings": { "get": { "tags": [ "evaluationRatings" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "evaluationDate", "in": "query", "description": "The date for the person's evaluation.", "schema": { "type": "string", "format": "date-time" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "localCourseCode", "in": "query", "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "sectionIdentifier", "in": "query", "description": "The local identifier assigned to a section.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "sessionName", "in": "query", "description": "The identifier for the calendar for the academic session.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "evaluationRatingLevelDescriptor", "in": "query", "description": "The rating level achieved based upon the rating or score.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "evaluationRatingStatusDescriptor", "in": "query", "description": "The Status of the poerformance evaluation.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "actualDuration", "in": "query", "description": "The actual or estimated number of clock minutes during which the evaluation was conducted.", "schema": { "type": "integer", "format": "int32" } }, { "name": "comments", "in": "query", "description": "Any comments about the evaluation to be captured.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationRating" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationRatings" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationRating", "requestBody": { "description": "The JSON representation of the \"evaluationRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRating" } } }, "required": true, "x-bodyName": "evaluationRating" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationRatings/{id}": { "get": { "tags": [ "evaluationRatings" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRating" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationRatings" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationRating", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRating" } } }, "required": true, "x-bodyName": "evaluationRating" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationRatings" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationRatingById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationRatings/deletes": { "get": { "tags": [ "evaluationRatings" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationRatingDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationRatings/keyChanges": { "get": { "tags": [ "evaluationRatings" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationRatingKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationRatings/partitions": { "get": { "tags": [ "evaluationRatings" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationRatingsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "evaluationDate", "in": "query", "description": "The date for the person's evaluation.", "schema": { "type": "string", "format": "date-time" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationTitle", "in": "query", "description": "The name or title of the evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "localCourseCode", "in": "query", "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "sectionIdentifier", "in": "query", "description": "The local identifier assigned to a section.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "sessionName", "in": "query", "description": "The identifier for the calendar for the academic session.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "evaluationRatingLevelDescriptor", "in": "query", "description": "The rating level achieved based upon the rating or score.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "evaluationRatingStatusDescriptor", "in": "query", "description": "The Status of the poerformance evaluation.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "actualDuration", "in": "query", "description": "The actual or estimated number of clock minutes during which the evaluation was conducted.", "schema": { "type": "integer", "format": "int32" } }, { "name": "comments", "in": "query", "description": "Any comments about the evaluation to be captured.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationRatingLevelDescriptors": { "get": { "tags": [ "evaluationRatingLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationRatingLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationRatingLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationRatingLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"evaluationRatingLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRatingLevelDescriptor" } } }, "required": true, "x-bodyName": "evaluationRatingLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationRatingLevelDescriptors/{id}": { "get": { "tags": [ "evaluationRatingLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationRatingLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRatingLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationRatingLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationRatingLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationRatingLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRatingLevelDescriptor" } } }, "required": true, "x-bodyName": "evaluationRatingLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationRatingLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationRatingLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationRatingLevelDescriptors/deletes": { "get": { "tags": [ "evaluationRatingLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationRatingLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationRatingLevelDescriptors/keyChanges": { "get": { "tags": [ "evaluationRatingLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationRatingLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationRatingLevelDescriptors/partitions": { "get": { "tags": [ "evaluationRatingLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationRatingLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationRatingStatusDescriptors": { "get": { "tags": [ "evaluationRatingStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationRatingStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationRatingStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationRatingStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationRatingStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"evaluationRatingStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRatingStatusDescriptor" } } }, "required": true, "x-bodyName": "evaluationRatingStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationRatingStatusDescriptors/{id}": { "get": { "tags": [ "evaluationRatingStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationRatingStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRatingStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationRatingStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationRatingStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationRatingStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationRatingStatusDescriptor" } } }, "required": true, "x-bodyName": "evaluationRatingStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationRatingStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationRatingStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationRatingStatusDescriptors/deletes": { "get": { "tags": [ "evaluationRatingStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationRatingStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationRatingStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationRatingStatusDescriptors/keyChanges": { "get": { "tags": [ "evaluationRatingStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationRatingStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationRatingStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationRatingStatusDescriptors/partitions": { "get": { "tags": [ "evaluationRatingStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationRatingStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/evaluationRubricDimensions": { "get": { "tags": [ "evaluationRubricDimensions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationRubricDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "evaluationRubricRating", "in": "query", "description": "The numeric rating associated with the evaluation rubric dimension.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEvaluationElementTitle", "in": "query", "description": "The name or title of the program evaluation element.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEvaluationPeriodDescriptor", "in": "query", "description": "The name of the period for the program evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the student program evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEvaluationTypeDescriptor", "in": "query", "description": "The type of program evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programName", "in": "query", "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programTypeDescriptor", "in": "query", "description": "The type of program.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationRubricRatingLevelDescriptor", "in": "query", "description": "The rating level achieved for the evaluation rubric dimension.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "evaluationCriterionDescription", "in": "query", "description": "The evaluation criterion description for the evaluation rubric dimension.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "rubricDimensionSortOrder", "in": "query", "description": "The sort order of the rubric dimension.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_evaluationRubricDimension" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationRubricDimensions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationRubricDimension", "requestBody": { "description": "The JSON representation of the \"evaluationRubricDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_evaluationRubricDimension" } } }, "required": true, "x-bodyName": "evaluationRubricDimension" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/evaluationRubricDimensions/{id}": { "get": { "tags": [ "evaluationRubricDimensions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationRubricDimensionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_evaluationRubricDimension" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationRubricDimensions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationRubricDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_evaluationRubricDimension" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationRubricDimensions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationRubricDimensionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/evaluationRubricDimensions/deletes": { "get": { "tags": [ "evaluationRubricDimensions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationRubricDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_evaluationRubricDimensionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/evaluationRubricDimensions/keyChanges": { "get": { "tags": [ "evaluationRubricDimensions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationRubricDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_evaluationRubricDimensionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/evaluationRubricDimensions/partitions": { "get": { "tags": [ "evaluationRubricDimensions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationRubricDimensionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "evaluationRubricRating", "in": "query", "description": "The numeric rating associated with the evaluation rubric dimension.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEvaluationElementTitle", "in": "query", "description": "The name or title of the program evaluation element.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEvaluationPeriodDescriptor", "in": "query", "description": "The name of the period for the program evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the student program evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programEvaluationTypeDescriptor", "in": "query", "description": "The type of program evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programName", "in": "query", "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programTypeDescriptor", "in": "query", "description": "The type of program.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationRubricRatingLevelDescriptor", "in": "query", "description": "The rating level achieved for the evaluation rubric dimension.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "evaluationCriterionDescription", "in": "query", "description": "The evaluation criterion description for the evaluation rubric dimension.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "rubricDimensionSortOrder", "in": "query", "description": "The sort order of the rubric dimension.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/evaluationTypeDescriptors": { "get": { "tags": [ "evaluationTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_evaluationTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "evaluationTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEvaluationTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"evaluationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationTypeDescriptor" } } }, "required": true, "x-bodyName": "evaluationTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationTypeDescriptors/{id}": { "get": { "tags": [ "evaluationTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEvaluationTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "evaluationTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEvaluationTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"evaluationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_evaluationTypeDescriptor" } } }, "required": true, "x-bodyName": "evaluationTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "evaluationTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEvaluationTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/evaluationTypeDescriptors/deletes": { "get": { "tags": [ "evaluationTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationTypeDescriptors/keyChanges": { "get": { "tags": [ "evaluationTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_evaluationTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/evaluationTypeDescriptors/partitions": { "get": { "tags": [ "evaluationTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEvaluationTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/eventCircumstanceDescriptors": { "get": { "tags": [ "eventCircumstanceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getEventCircumstanceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_eventCircumstanceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "eventCircumstanceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postEventCircumstanceDescriptor", "requestBody": { "description": "The JSON representation of the \"eventCircumstanceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eventCircumstanceDescriptor" } } }, "required": true, "x-bodyName": "eventCircumstanceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/eventCircumstanceDescriptors/{id}": { "get": { "tags": [ "eventCircumstanceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getEventCircumstanceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eventCircumstanceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "eventCircumstanceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putEventCircumstanceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"eventCircumstanceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_eventCircumstanceDescriptor" } } }, "required": true, "x-bodyName": "eventCircumstanceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "eventCircumstanceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteEventCircumstanceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/eventCircumstanceDescriptors/deletes": { "get": { "tags": [ "eventCircumstanceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesEventCircumstanceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_eventCircumstanceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/eventCircumstanceDescriptors/keyChanges": { "get": { "tags": [ "eventCircumstanceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesEventCircumstanceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_eventCircumstanceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/eventCircumstanceDescriptors/partitions": { "get": { "tags": [ "eventCircumstanceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getEventCircumstanceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/exitWithdrawTypeDescriptors": { "get": { "tags": [ "exitWithdrawTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getExitWithdrawTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_exitWithdrawTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "exitWithdrawTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postExitWithdrawTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"exitWithdrawTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_exitWithdrawTypeDescriptor" } } }, "required": true, "x-bodyName": "exitWithdrawTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/exitWithdrawTypeDescriptors/{id}": { "get": { "tags": [ "exitWithdrawTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getExitWithdrawTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_exitWithdrawTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "exitWithdrawTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putExitWithdrawTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"exitWithdrawTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_exitWithdrawTypeDescriptor" } } }, "required": true, "x-bodyName": "exitWithdrawTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "exitWithdrawTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteExitWithdrawTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/exitWithdrawTypeDescriptors/deletes": { "get": { "tags": [ "exitWithdrawTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesExitWithdrawTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_exitWithdrawTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/exitWithdrawTypeDescriptors/keyChanges": { "get": { "tags": [ "exitWithdrawTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesExitWithdrawTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_exitWithdrawTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/exitWithdrawTypeDescriptors/partitions": { "get": { "tags": [ "exitWithdrawTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getExitWithdrawTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/feederSchoolAssociations": { "get": { "tags": [ "feederSchoolAssociations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getFeederSchoolAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "beginDate", "in": "query", "description": "The month, day, and year of the first day of the feeder school association. 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.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "feederSchoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "endDate", "in": "query", "description": "The month, day, and year of the last day of the feeder school association. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "feederRelationshipDescription", "in": "query", "description": "Describes the relationship from the feeder school to the receiving school, for example by program emphasis, such as special education, language immersion, science, or performing art.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_feederSchoolAssociation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "feederSchoolAssociations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postFeederSchoolAssociation", "requestBody": { "description": "The JSON representation of the \"feederSchoolAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_feederSchoolAssociation" } } }, "required": true, "x-bodyName": "feederSchoolAssociation" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/feederSchoolAssociations/{id}": { "get": { "tags": [ "feederSchoolAssociations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getFeederSchoolAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_feederSchoolAssociation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "feederSchoolAssociations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"feederSchoolAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_feederSchoolAssociation" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "feederSchoolAssociations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteFeederSchoolAssociationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/feederSchoolAssociations/deletes": { "get": { "tags": [ "feederSchoolAssociations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesFeederSchoolAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_feederSchoolAssociationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/feederSchoolAssociations/keyChanges": { "get": { "tags": [ "feederSchoolAssociations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesFeederSchoolAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_feederSchoolAssociationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/feederSchoolAssociations/partitions": { "get": { "tags": [ "feederSchoolAssociations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getFeederSchoolAssociationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "beginDate", "in": "query", "description": "The month, day, and year of the first day of the feeder school association. 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.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "feederSchoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "endDate", "in": "query", "description": "The month, day, and year of the last day of the feeder school association. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "feederRelationshipDescription", "in": "query", "description": "Describes the relationship from the feeder school to the receiving school, for example by program emphasis, such as special education, language immersion, science, or performing art.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/financialAids": { "get": { "tags": [ "financialAids" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getFinancialAids", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "aidTypeDescriptor", "in": "query", "description": "The classification of financial aid awarded to a person for the academic term/year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "The date the award was designated. 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.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "aidAmount", "in": "query", "description": "The amount of financial aid awarded to a person for the term/year.", "schema": { "type": "number", "format": "double" } }, { "name": "aidConditionDescription", "in": "query", "description": "The description of the condition (e.g., placement in a high need school) under which the aid was given.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "endDate", "in": "query", "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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "pellGrantRecipient", "in": "query", "description": "Indicates a person who receives Pell Grant aid.", "schema": { "type": "boolean" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_financialAid" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "financialAids" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postFinancialAid", "requestBody": { "description": "The JSON representation of the \"financialAid\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_financialAid" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/financialAids/{id}": { "get": { "tags": [ "financialAids" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getFinancialAidsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_financialAid" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "financialAids" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putFinancialAid", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"financialAid\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_financialAid" } } }, "required": true, "x-bodyName": "financialAid" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "financialAids" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteFinancialAidById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/financialAids/deletes": { "get": { "tags": [ "financialAids" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesFinancialAids", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_financialAidDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/financialAids/keyChanges": { "get": { "tags": [ "financialAids" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesFinancialAids", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_financialAidKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/financialAids/partitions": { "get": { "tags": [ "financialAids" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getFinancialAidsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "aidTypeDescriptor", "in": "query", "description": "The classification of financial aid awarded to a person for the academic term/year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "The date the award was designated. 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.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "aidAmount", "in": "query", "description": "The amount of financial aid awarded to a person for the term/year.", "schema": { "type": "number", "format": "double" } }, { "name": "aidConditionDescription", "in": "query", "description": "The description of the condition (e.g., placement in a high need school) under which the aid was given.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "endDate", "in": "query", "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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "pellGrantRecipient", "in": "query", "description": "Indicates a person who receives Pell Grant aid.", "schema": { "type": "boolean" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/financialCollectionDescriptors": { "get": { "tags": [ "financialCollectionDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getFinancialCollectionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_financialCollectionDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "financialCollectionDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postFinancialCollectionDescriptor", "requestBody": { "description": "The JSON representation of the \"financialCollectionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_financialCollectionDescriptor" } } }, "required": true, "x-bodyName": "financialCollectionDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/financialCollectionDescriptors/{id}": { "get": { "tags": [ "financialCollectionDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getFinancialCollectionDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_financialCollectionDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "financialCollectionDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putFinancialCollectionDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"financialCollectionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_financialCollectionDescriptor" } } }, "required": true, "x-bodyName": "financialCollectionDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "financialCollectionDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteFinancialCollectionDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/financialCollectionDescriptors/deletes": { "get": { "tags": [ "financialCollectionDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesFinancialCollectionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_financialCollectionDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/financialCollectionDescriptors/keyChanges": { "get": { "tags": [ "financialCollectionDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesFinancialCollectionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_financialCollectionDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/financialCollectionDescriptors/partitions": { "get": { "tags": [ "financialCollectionDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getFinancialCollectionDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/functionDimensions": { "get": { "tags": [ "functionDimensions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getFunctionDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "code", "in": "query", "description": "The code representation of the account function dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account function dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account function dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_functionDimension" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "functionDimensions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postFunctionDimension", "requestBody": { "description": "The JSON representation of the \"functionDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_functionDimension" } } }, "required": true, "x-bodyName": "functionDimension" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/functionDimensions/{id}": { "get": { "tags": [ "functionDimensions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getFunctionDimensionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_functionDimension" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "functionDimensions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"functionDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_functionDimension" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "functionDimensions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteFunctionDimensionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/functionDimensions/deletes": { "get": { "tags": [ "functionDimensions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesFunctionDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_functionDimensionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/functionDimensions/keyChanges": { "get": { "tags": [ "functionDimensions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesFunctionDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_functionDimensionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/functionDimensions/partitions": { "get": { "tags": [ "functionDimensions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getFunctionDimensionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "code", "in": "query", "description": "The code representation of the account function dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account function dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account function dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/fundDimensions": { "get": { "tags": [ "fundDimensions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getFundDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "code", "in": "query", "description": "The code representation of the account fund dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account fund dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account fund dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_fundDimension" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "fundDimensions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postFundDimension", "requestBody": { "description": "The JSON representation of the \"fundDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_fundDimension" } } }, "required": true, "x-bodyName": "fundDimension" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/fundDimensions/{id}": { "get": { "tags": [ "fundDimensions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getFundDimensionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_fundDimension" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "fundDimensions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"fundDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_fundDimension" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "fundDimensions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteFundDimensionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/fundDimensions/deletes": { "get": { "tags": [ "fundDimensions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesFundDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_fundDimensionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/fundDimensions/keyChanges": { "get": { "tags": [ "fundDimensions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesFundDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_fundDimensionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/fundDimensions/partitions": { "get": { "tags": [ "fundDimensions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getFundDimensionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "code", "in": "query", "description": "The code representation of the account fund dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account fund dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account fund dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/genderDescriptors": { "get": { "tags": [ "genderDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGenderDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_genderDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "genderDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGenderDescriptor", "requestBody": { "description": "The JSON representation of the \"genderDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_genderDescriptor" } } }, "required": true, "x-bodyName": "genderDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/genderDescriptors/{id}": { "get": { "tags": [ "genderDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGenderDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_genderDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "genderDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putGenderDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"genderDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_genderDescriptor" } } }, "required": true, "x-bodyName": "genderDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "genderDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGenderDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/genderDescriptors/deletes": { "get": { "tags": [ "genderDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGenderDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_genderDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/genderDescriptors/keyChanges": { "get": { "tags": [ "genderDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGenderDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_genderDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/genderDescriptors/partitions": { "get": { "tags": [ "genderDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGenderDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/grades": { "get": { "tags": [ "grades" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGrades", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "gradeTypeDescriptor", "in": "query", "description": "The type of grade reported (e.g., exam, final, grading period).", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodDescriptor", "in": "query", "description": "The state's name of the period for which grades are reported.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodName", "in": "query", "description": "The school's descriptive name of the grading period.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodSchoolYear", "in": "query", "description": "The identifier for the grading period school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "Month, day, and year of the student's entry or assignment to the section. 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.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "localCourseCode", "in": "query", "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "sectionIdentifier", "in": "query", "description": "The local identifier assigned to a section.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sessionName", "in": "query", "description": "The identifier for the calendar for the academic session.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceBaseConversionDescriptor", "in": "query", "description": "A conversion of the level to a standard set of performance levels.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "currentGradeAsOfDate", "in": "query", "description": "As-Of date for a grade posted as the current grade.", "schema": { "type": "string", "format": "date" } }, { "name": "currentGradeIndicator", "in": "query", "description": "An indicator that the posted grade is an interim grade for the grading period and not the final grade.", "schema": { "type": "boolean" } }, { "name": "diagnosticStatement", "in": "query", "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "gradeEarnedDescription", "in": "query", "description": "A description of the grade earned by the learner.", "schema": { "maxLength": 64, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "letterGradeEarned", "in": "query", "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "numericGradeEarned", "in": "query", "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", "schema": { "type": "number", "format": "double" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_grade" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "grades" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGrade", "requestBody": { "description": "The JSON representation of the \"grade\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_grade" } } }, "required": true, "x-bodyName": "grade" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/grades/{id}": { "get": { "tags": [ "grades" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGradesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_grade" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "grades" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, if natural key values are being updated by the JSON body, those changes will be applied to the resource and will also cascade through to dependent resources.", "operationId": "putGrade", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"grade\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_grade" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } }, "x-Ed-Fi-isUpdatable": true }, "delete": { "tags": [ "grades" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGradeById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/grades/deletes": { "get": { "tags": [ "grades" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGrades", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradeDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/grades/keyChanges": { "get": { "tags": [ "grades" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGrades", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradeKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/grades/partitions": { "get": { "tags": [ "grades" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGradesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "gradeTypeDescriptor", "in": "query", "description": "The type of grade reported (e.g., exam, final, grading period).", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodDescriptor", "in": "query", "description": "The state's name of the period for which grades are reported.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodName", "in": "query", "description": "The school's descriptive name of the grading period.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodSchoolYear", "in": "query", "description": "The identifier for the grading period school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "Month, day, and year of the student's entry or assignment to the section. 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.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "localCourseCode", "in": "query", "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "sectionIdentifier", "in": "query", "description": "The local identifier assigned to a section.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sessionName", "in": "query", "description": "The identifier for the calendar for the academic session.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceBaseConversionDescriptor", "in": "query", "description": "A conversion of the level to a standard set of performance levels.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "currentGradeAsOfDate", "in": "query", "description": "As-Of date for a grade posted as the current grade.", "schema": { "type": "string", "format": "date" } }, { "name": "currentGradeIndicator", "in": "query", "description": "An indicator that the posted grade is an interim grade for the grading period and not the final grade.", "schema": { "type": "boolean" } }, { "name": "diagnosticStatement", "in": "query", "description": "A statement provided by the teacher that provides information in addition to the grade or assessment score.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "gradeEarnedDescription", "in": "query", "description": "A description of the grade earned by the learner.", "schema": { "maxLength": 64, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "letterGradeEarned", "in": "query", "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "numericGradeEarned", "in": "query", "description": "A final or interim (grading period) indicator of student performance in a class as submitted by the instructor.", "schema": { "type": "number", "format": "double" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/gradebookEntries": { "get": { "tags": [ "gradebookEntries" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGradebookEntries", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "gradebookEntryIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to a gradebook entry by the source system.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace URI for the source of the gradebook entry.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodDescriptor", "in": "query", "description": "The state's name of the period for which grades are reported.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "gradingPeriodName", "in": "query", "description": "The school's descriptive name of the grading period.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" } }, { "name": "localCourseCode", "in": "query", "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "sectionIdentifier", "in": "query", "description": "The local identifier assigned to a section.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "sessionName", "in": "query", "description": "The identifier for the calendar for the academic session.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "gradebookEntryTypeDescriptor", "in": "query", "description": "The type of the gradebook entry.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "dateAssigned", "in": "query", "description": "The date the assignment, homework, or assessment was assigned or executed.", "schema": { "type": "string", "format": "date" } }, { "name": "description", "in": "query", "description": "A description of the assignment, homework, or classroom assessment.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "dueDate", "in": "query", "description": "The date the assignment, homework, or assessment is due.", "schema": { "type": "string", "format": "date" } }, { "name": "dueTime", "in": "query", "description": "The time the assignment, homework, or assessment is due.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxPoints", "in": "query", "description": "The maximum number of points that can be earned for the submission.", "schema": { "type": "number", "format": "double" } }, { "name": "sourceSectionIdentifier", "in": "query", "description": "The local identifier assigned to a section.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "title", "in": "query", "description": "The name or title of the activity to be recorded in the gradebook entry.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_gradebookEntry" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "gradebookEntries" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGradebookEntry", "requestBody": { "description": "The JSON representation of the \"gradebookEntry\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradebookEntry" } } }, "required": true, "x-bodyName": "gradebookEntry" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradebookEntries/{id}": { "get": { "tags": [ "gradebookEntries" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGradebookEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradebookEntry" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "gradebookEntries" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, if natural key values are being updated by the JSON body, those changes will be applied to the resource and will also cascade through to dependent resources.", "operationId": "putGradebookEntry", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"gradebookEntry\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradebookEntry" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } }, "x-Ed-Fi-isUpdatable": true }, "delete": { "tags": [ "gradebookEntries" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGradebookEntryById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradebookEntries/deletes": { "get": { "tags": [ "gradebookEntries" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGradebookEntries", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradebookEntryDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradebookEntries/keyChanges": { "get": { "tags": [ "gradebookEntries" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGradebookEntries", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradebookEntryKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradebookEntries/partitions": { "get": { "tags": [ "gradebookEntries" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGradebookEntriesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "gradebookEntryIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to a gradebook entry by the source system.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace URI for the source of the gradebook entry.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodDescriptor", "in": "query", "description": "The state's name of the period for which grades are reported.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "gradingPeriodName", "in": "query", "description": "The school's descriptive name of the grading period.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" } }, { "name": "localCourseCode", "in": "query", "description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "sectionIdentifier", "in": "query", "description": "The local identifier assigned to a section.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "sessionName", "in": "query", "description": "The identifier for the calendar for the academic session.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "gradebookEntryTypeDescriptor", "in": "query", "description": "The type of the gradebook entry.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "dateAssigned", "in": "query", "description": "The date the assignment, homework, or assessment was assigned or executed.", "schema": { "type": "string", "format": "date" } }, { "name": "description", "in": "query", "description": "A description of the assignment, homework, or classroom assessment.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "dueDate", "in": "query", "description": "The date the assignment, homework, or assessment is due.", "schema": { "type": "string", "format": "date" } }, { "name": "dueTime", "in": "query", "description": "The time the assignment, homework, or assessment is due.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxPoints", "in": "query", "description": "The maximum number of points that can be earned for the submission.", "schema": { "type": "number", "format": "double" } }, { "name": "sourceSectionIdentifier", "in": "query", "description": "The local identifier assigned to a section.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "title", "in": "query", "description": "The name or title of the activity to be recorded in the gradebook entry.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/gradebookEntryTypeDescriptors": { "get": { "tags": [ "gradebookEntryTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGradebookEntryTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_gradebookEntryTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "gradebookEntryTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGradebookEntryTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"gradebookEntryTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradebookEntryTypeDescriptor" } } }, "required": true, "x-bodyName": "gradebookEntryTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradebookEntryTypeDescriptors/{id}": { "get": { "tags": [ "gradebookEntryTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGradebookEntryTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradebookEntryTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "gradebookEntryTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putGradebookEntryTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"gradebookEntryTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradebookEntryTypeDescriptor" } } }, "required": true, "x-bodyName": "gradebookEntryTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "gradebookEntryTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGradebookEntryTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradebookEntryTypeDescriptors/deletes": { "get": { "tags": [ "gradebookEntryTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGradebookEntryTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradebookEntryTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradebookEntryTypeDescriptors/keyChanges": { "get": { "tags": [ "gradebookEntryTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGradebookEntryTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradebookEntryTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradebookEntryTypeDescriptors/partitions": { "get": { "tags": [ "gradebookEntryTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGradebookEntryTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/gradeLevelDescriptors": { "get": { "tags": [ "gradeLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGradeLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_gradeLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "gradeLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGradeLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"gradeLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradeLevelDescriptor" } } }, "required": true, "x-bodyName": "gradeLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradeLevelDescriptors/{id}": { "get": { "tags": [ "gradeLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGradeLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradeLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "gradeLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putGradeLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"gradeLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradeLevelDescriptor" } } }, "required": true, "x-bodyName": "gradeLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "gradeLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGradeLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradeLevelDescriptors/deletes": { "get": { "tags": [ "gradeLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGradeLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradeLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradeLevelDescriptors/keyChanges": { "get": { "tags": [ "gradeLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGradeLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradeLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradeLevelDescriptors/partitions": { "get": { "tags": [ "gradeLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGradeLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/gradePointAverageTypeDescriptors": { "get": { "tags": [ "gradePointAverageTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGradePointAverageTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_gradePointAverageTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "gradePointAverageTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGradePointAverageTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"gradePointAverageTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradePointAverageTypeDescriptor" } } }, "required": true, "x-bodyName": "gradePointAverageTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradePointAverageTypeDescriptors/{id}": { "get": { "tags": [ "gradePointAverageTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGradePointAverageTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradePointAverageTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "gradePointAverageTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putGradePointAverageTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"gradePointAverageTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradePointAverageTypeDescriptor" } } }, "required": true, "x-bodyName": "gradePointAverageTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "gradePointAverageTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGradePointAverageTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradePointAverageTypeDescriptors/deletes": { "get": { "tags": [ "gradePointAverageTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGradePointAverageTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradePointAverageTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradePointAverageTypeDescriptors/keyChanges": { "get": { "tags": [ "gradePointAverageTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGradePointAverageTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradePointAverageTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradePointAverageTypeDescriptors/partitions": { "get": { "tags": [ "gradePointAverageTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGradePointAverageTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/gradeTypeDescriptors": { "get": { "tags": [ "gradeTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGradeTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_gradeTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "gradeTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGradeTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"gradeTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradeTypeDescriptor" } } }, "required": true, "x-bodyName": "gradeTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradeTypeDescriptors/{id}": { "get": { "tags": [ "gradeTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGradeTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradeTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "gradeTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putGradeTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"gradeTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradeTypeDescriptor" } } }, "required": true, "x-bodyName": "gradeTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "gradeTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGradeTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradeTypeDescriptors/deletes": { "get": { "tags": [ "gradeTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGradeTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradeTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradeTypeDescriptors/keyChanges": { "get": { "tags": [ "gradeTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGradeTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradeTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradeTypeDescriptors/partitions": { "get": { "tags": [ "gradeTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGradeTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/gradingPeriods": { "get": { "tags": [ "gradingPeriods" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGradingPeriods", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "gradingPeriodDescriptor", "in": "query", "description": "The state's name of the period for which grades are reported.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodName", "in": "query", "description": "The school's descriptive name of the grading period.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the grading period school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "Month, day, and year of the first day of the grading period. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "Month, day, and year of the last day of the grading period. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "periodSequence", "in": "query", "description": "The sequential order of this period relative to other periods.", "schema": { "type": "integer", "format": "int32" } }, { "name": "totalInstructionalDays", "in": "query", "description": "Total days available for educational instruction during the grading period.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_gradingPeriod" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "gradingPeriods" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGradingPeriod", "requestBody": { "description": "The JSON representation of the \"gradingPeriod\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradingPeriod" } } }, "required": true, "x-bodyName": "gradingPeriod" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradingPeriods/{id}": { "get": { "tags": [ "gradingPeriods" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGradingPeriodsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradingPeriod" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "gradingPeriods" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"gradingPeriod\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradingPeriod" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "gradingPeriods" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGradingPeriodById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradingPeriods/deletes": { "get": { "tags": [ "gradingPeriods" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGradingPeriods", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradingPeriodDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradingPeriods/keyChanges": { "get": { "tags": [ "gradingPeriods" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGradingPeriods", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradingPeriodKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradingPeriods/partitions": { "get": { "tags": [ "gradingPeriods" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGradingPeriodsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "gradingPeriodDescriptor", "in": "query", "description": "The state's name of the period for which grades are reported.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "gradingPeriodName", "in": "query", "description": "The school's descriptive name of the grading period.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the grading period school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "beginDate", "in": "query", "description": "Month, day, and year of the first day of the grading period. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "Month, day, and year of the last day of the grading period. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "periodSequence", "in": "query", "description": "The sequential order of this period relative to other periods.", "schema": { "type": "integer", "format": "int32" } }, { "name": "totalInstructionalDays", "in": "query", "description": "Total days available for educational instruction during the grading period.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/gradingPeriodDescriptors": { "get": { "tags": [ "gradingPeriodDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGradingPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_gradingPeriodDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "gradingPeriodDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGradingPeriodDescriptor", "requestBody": { "description": "The JSON representation of the \"gradingPeriodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradingPeriodDescriptor" } } }, "required": true, "x-bodyName": "gradingPeriodDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradingPeriodDescriptors/{id}": { "get": { "tags": [ "gradingPeriodDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGradingPeriodDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradingPeriodDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "gradingPeriodDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putGradingPeriodDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"gradingPeriodDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gradingPeriodDescriptor" } } }, "required": true, "x-bodyName": "gradingPeriodDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "gradingPeriodDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGradingPeriodDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gradingPeriodDescriptors/deletes": { "get": { "tags": [ "gradingPeriodDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGradingPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradingPeriodDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradingPeriodDescriptors/keyChanges": { "get": { "tags": [ "gradingPeriodDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGradingPeriodDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gradingPeriodDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gradingPeriodDescriptors/partitions": { "get": { "tags": [ "gradingPeriodDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGradingPeriodDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/graduationPlans": { "get": { "tags": [ "graduationPlans" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGraduationPlans", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "graduationPlanTypeDescriptor", "in": "query", "description": "The type of academic plan the student is following for graduation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "graduationSchoolYear", "in": "query", "description": "The school year the student is expected to graduate.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "totalRequiredCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "individualPlan", "in": "query", "description": "An indicator of whether the graduation plan is tailored for an individual.", "schema": { "type": "boolean" } }, { "name": "totalRequiredCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "totalRequiredCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_graduationPlan" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "graduationPlans" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGraduationPlan", "requestBody": { "description": "The JSON representation of the \"graduationPlan\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_graduationPlan" } } }, "required": true, "x-bodyName": "graduationPlan" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/graduationPlans/{id}": { "get": { "tags": [ "graduationPlans" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGraduationPlansById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_graduationPlan" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "graduationPlans" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"graduationPlan\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_graduationPlan" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "graduationPlans" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGraduationPlanById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/graduationPlans/deletes": { "get": { "tags": [ "graduationPlans" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGraduationPlans", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_graduationPlanDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/graduationPlans/keyChanges": { "get": { "tags": [ "graduationPlans" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGraduationPlans", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_graduationPlanKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/graduationPlans/partitions": { "get": { "tags": [ "graduationPlans" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGraduationPlansPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "graduationPlanTypeDescriptor", "in": "query", "description": "The type of academic plan the student is following for graduation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "graduationSchoolYear", "in": "query", "description": "The school year the student is expected to graduate.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "totalRequiredCreditTypeDescriptor", "in": "query", "description": "The type of credits or units of value awarded for the completion of a course.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "individualPlan", "in": "query", "description": "An indicator of whether the graduation plan is tailored for an individual.", "schema": { "type": "boolean" } }, { "name": "totalRequiredCreditConversion", "in": "query", "description": "Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units.", "schema": { "type": "number", "format": "double" } }, { "name": "totalRequiredCredits", "in": "query", "description": "The value of credits or units of value awarded for the completion of a course.", "schema": { "type": "number", "format": "double" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/graduationPlanTypeDescriptors": { "get": { "tags": [ "graduationPlanTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGraduationPlanTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_graduationPlanTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "graduationPlanTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGraduationPlanTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"graduationPlanTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_graduationPlanTypeDescriptor" } } }, "required": true, "x-bodyName": "graduationPlanTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/graduationPlanTypeDescriptors/{id}": { "get": { "tags": [ "graduationPlanTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGraduationPlanTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_graduationPlanTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "graduationPlanTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putGraduationPlanTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"graduationPlanTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_graduationPlanTypeDescriptor" } } }, "required": true, "x-bodyName": "graduationPlanTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "graduationPlanTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGraduationPlanTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/graduationPlanTypeDescriptors/deletes": { "get": { "tags": [ "graduationPlanTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGraduationPlanTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_graduationPlanTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/graduationPlanTypeDescriptors/keyChanges": { "get": { "tags": [ "graduationPlanTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGraduationPlanTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_graduationPlanTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/graduationPlanTypeDescriptors/partitions": { "get": { "tags": [ "graduationPlanTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGraduationPlanTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors": { "get": { "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getGunFreeSchoolsActReportingStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_gunFreeSchoolsActReportingStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postGunFreeSchoolsActReportingStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"gunFreeSchoolsActReportingStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gunFreeSchoolsActReportingStatusDescriptor" } } }, "required": true, "x-bodyName": "gunFreeSchoolsActReportingStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { "get": { "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getGunFreeSchoolsActReportingStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gunFreeSchoolsActReportingStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putGunFreeSchoolsActReportingStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"gunFreeSchoolsActReportingStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_gunFreeSchoolsActReportingStatusDescriptor" } } }, "required": true, "x-bodyName": "gunFreeSchoolsActReportingStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteGunFreeSchoolsActReportingStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/deletes": { "get": { "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesGunFreeSchoolsActReportingStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gunFreeSchoolsActReportingStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/keyChanges": { "get": { "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesGunFreeSchoolsActReportingStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_gunFreeSchoolsActReportingStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/partitions": { "get": { "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getGunFreeSchoolsActReportingStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors": { "get": { "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getHomelessPrimaryNighttimeResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_homelessPrimaryNighttimeResidenceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postHomelessPrimaryNighttimeResidenceDescriptor", "requestBody": { "description": "The JSON representation of the \"homelessPrimaryNighttimeResidenceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_homelessPrimaryNighttimeResidenceDescriptor" } } }, "required": true, "x-bodyName": "homelessPrimaryNighttimeResidenceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { "get": { "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getHomelessPrimaryNighttimeResidenceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_homelessPrimaryNighttimeResidenceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putHomelessPrimaryNighttimeResidenceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"homelessPrimaryNighttimeResidenceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_homelessPrimaryNighttimeResidenceDescriptor" } } }, "required": true, "x-bodyName": "homelessPrimaryNighttimeResidenceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteHomelessPrimaryNighttimeResidenceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/deletes": { "get": { "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesHomelessPrimaryNighttimeResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_homelessPrimaryNighttimeResidenceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/keyChanges": { "get": { "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesHomelessPrimaryNighttimeResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_homelessPrimaryNighttimeResidenceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/partitions": { "get": { "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getHomelessPrimaryNighttimeResidenceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/homelessProgramServiceDescriptors": { "get": { "tags": [ "homelessProgramServiceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getHomelessProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_homelessProgramServiceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "homelessProgramServiceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postHomelessProgramServiceDescriptor", "requestBody": { "description": "The JSON representation of the \"homelessProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_homelessProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "homelessProgramServiceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/homelessProgramServiceDescriptors/{id}": { "get": { "tags": [ "homelessProgramServiceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getHomelessProgramServiceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_homelessProgramServiceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "homelessProgramServiceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putHomelessProgramServiceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"homelessProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_homelessProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "homelessProgramServiceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "homelessProgramServiceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteHomelessProgramServiceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/homelessProgramServiceDescriptors/deletes": { "get": { "tags": [ "homelessProgramServiceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesHomelessProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_homelessProgramServiceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/homelessProgramServiceDescriptors/keyChanges": { "get": { "tags": [ "homelessProgramServiceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesHomelessProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_homelessProgramServiceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/homelessProgramServiceDescriptors/partitions": { "get": { "tags": [ "homelessProgramServiceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getHomelessProgramServiceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/ideaPartDescriptors": { "get": { "tags": [ "ideaPartDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getIDEAPartDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_ideaPartDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "ideaPartDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postIDEAPartDescriptor", "requestBody": { "description": "The JSON representation of the \"ideaPartDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_ideaPartDescriptor" } } }, "required": true, "x-bodyName": "ideaPartDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/ideaPartDescriptors/{id}": { "get": { "tags": [ "ideaPartDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getIDEAPartDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_ideaPartDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "ideaPartDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putIDEAPartDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"ideaPartDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_ideaPartDescriptor" } } }, "required": true, "x-bodyName": "ideaPartDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "ideaPartDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteIDEAPartDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/ideaPartDescriptors/deletes": { "get": { "tags": [ "ideaPartDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesIDEAPartDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_ideaPartDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/ideaPartDescriptors/keyChanges": { "get": { "tags": [ "ideaPartDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesIDEAPartDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_ideaPartDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/ideaPartDescriptors/partitions": { "get": { "tags": [ "ideaPartDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getIDEAPartDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/identificationDocumentUseDescriptors": { "get": { "tags": [ "identificationDocumentUseDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getIdentificationDocumentUseDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_identificationDocumentUseDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "identificationDocumentUseDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postIdentificationDocumentUseDescriptor", "requestBody": { "description": "The JSON representation of the \"identificationDocumentUseDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_identificationDocumentUseDescriptor" } } }, "required": true, "x-bodyName": "identificationDocumentUseDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/identificationDocumentUseDescriptors/{id}": { "get": { "tags": [ "identificationDocumentUseDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getIdentificationDocumentUseDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_identificationDocumentUseDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "identificationDocumentUseDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putIdentificationDocumentUseDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"identificationDocumentUseDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_identificationDocumentUseDescriptor" } } }, "required": true, "x-bodyName": "identificationDocumentUseDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "identificationDocumentUseDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteIdentificationDocumentUseDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/identificationDocumentUseDescriptors/deletes": { "get": { "tags": [ "identificationDocumentUseDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesIdentificationDocumentUseDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_identificationDocumentUseDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/identificationDocumentUseDescriptors/keyChanges": { "get": { "tags": [ "identificationDocumentUseDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesIdentificationDocumentUseDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_identificationDocumentUseDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/identificationDocumentUseDescriptors/partitions": { "get": { "tags": [ "identificationDocumentUseDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getIdentificationDocumentUseDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/immunizationTypeDescriptors": { "get": { "tags": [ "immunizationTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getImmunizationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_immunizationTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "immunizationTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postImmunizationTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"immunizationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_immunizationTypeDescriptor" } } }, "required": true, "x-bodyName": "immunizationTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/immunizationTypeDescriptors/{id}": { "get": { "tags": [ "immunizationTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getImmunizationTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_immunizationTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "immunizationTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putImmunizationTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"immunizationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_immunizationTypeDescriptor" } } }, "required": true, "x-bodyName": "immunizationTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "immunizationTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteImmunizationTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/immunizationTypeDescriptors/deletes": { "get": { "tags": [ "immunizationTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesImmunizationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_immunizationTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/immunizationTypeDescriptors/keyChanges": { "get": { "tags": [ "immunizationTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesImmunizationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_immunizationTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/immunizationTypeDescriptors/partitions": { "get": { "tags": [ "immunizationTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getImmunizationTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/incidentLocationDescriptors": { "get": { "tags": [ "incidentLocationDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getIncidentLocationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_incidentLocationDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "incidentLocationDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postIncidentLocationDescriptor", "requestBody": { "description": "The JSON representation of the \"incidentLocationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_incidentLocationDescriptor" } } }, "required": true, "x-bodyName": "incidentLocationDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/incidentLocationDescriptors/{id}": { "get": { "tags": [ "incidentLocationDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getIncidentLocationDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_incidentLocationDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "incidentLocationDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putIncidentLocationDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"incidentLocationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_incidentLocationDescriptor" } } }, "required": true, "x-bodyName": "incidentLocationDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "incidentLocationDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteIncidentLocationDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/incidentLocationDescriptors/deletes": { "get": { "tags": [ "incidentLocationDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesIncidentLocationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_incidentLocationDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/incidentLocationDescriptors/keyChanges": { "get": { "tags": [ "incidentLocationDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesIncidentLocationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_incidentLocationDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/incidentLocationDescriptors/partitions": { "get": { "tags": [ "incidentLocationDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getIncidentLocationDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/indicatorDescriptors": { "get": { "tags": [ "indicatorDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getIndicatorDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_indicatorDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "indicatorDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postIndicatorDescriptor", "requestBody": { "description": "The JSON representation of the \"indicatorDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorDescriptor" } } }, "required": true, "x-bodyName": "indicatorDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/indicatorDescriptors/{id}": { "get": { "tags": [ "indicatorDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getIndicatorDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "indicatorDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putIndicatorDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"indicatorDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorDescriptor" } } }, "required": true, "x-bodyName": "indicatorDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "indicatorDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteIndicatorDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/indicatorDescriptors/deletes": { "get": { "tags": [ "indicatorDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesIndicatorDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_indicatorDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/indicatorDescriptors/keyChanges": { "get": { "tags": [ "indicatorDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesIndicatorDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_indicatorDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/indicatorDescriptors/partitions": { "get": { "tags": [ "indicatorDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getIndicatorDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/indicatorGroupDescriptors": { "get": { "tags": [ "indicatorGroupDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getIndicatorGroupDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_indicatorGroupDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "indicatorGroupDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postIndicatorGroupDescriptor", "requestBody": { "description": "The JSON representation of the \"indicatorGroupDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorGroupDescriptor" } } }, "required": true, "x-bodyName": "indicatorGroupDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/indicatorGroupDescriptors/{id}": { "get": { "tags": [ "indicatorGroupDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getIndicatorGroupDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorGroupDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "indicatorGroupDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putIndicatorGroupDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"indicatorGroupDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorGroupDescriptor" } } }, "required": true, "x-bodyName": "indicatorGroupDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "indicatorGroupDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteIndicatorGroupDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/indicatorGroupDescriptors/deletes": { "get": { "tags": [ "indicatorGroupDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesIndicatorGroupDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_indicatorGroupDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/indicatorGroupDescriptors/keyChanges": { "get": { "tags": [ "indicatorGroupDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesIndicatorGroupDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_indicatorGroupDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/indicatorGroupDescriptors/partitions": { "get": { "tags": [ "indicatorGroupDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getIndicatorGroupDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/indicatorLevelDescriptors": { "get": { "tags": [ "indicatorLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getIndicatorLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_indicatorLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "indicatorLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postIndicatorLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"indicatorLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorLevelDescriptor" } } }, "required": true, "x-bodyName": "indicatorLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/indicatorLevelDescriptors/{id}": { "get": { "tags": [ "indicatorLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getIndicatorLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "indicatorLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putIndicatorLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"indicatorLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_indicatorLevelDescriptor" } } }, "required": true, "x-bodyName": "indicatorLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "indicatorLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteIndicatorLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/indicatorLevelDescriptors/deletes": { "get": { "tags": [ "indicatorLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesIndicatorLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_indicatorLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/indicatorLevelDescriptors/keyChanges": { "get": { "tags": [ "indicatorLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesIndicatorLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_indicatorLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/indicatorLevelDescriptors/partitions": { "get": { "tags": [ "indicatorLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getIndicatorLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/institutionTelephoneNumberTypeDescriptors": { "get": { "tags": [ "institutionTelephoneNumberTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInstitutionTelephoneNumberTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_institutionTelephoneNumberTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "institutionTelephoneNumberTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInstitutionTelephoneNumberTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"institutionTelephoneNumberTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_institutionTelephoneNumberTypeDescriptor" } } }, "required": true, "x-bodyName": "institutionTelephoneNumberTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { "get": { "tags": [ "institutionTelephoneNumberTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInstitutionTelephoneNumberTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_institutionTelephoneNumberTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "institutionTelephoneNumberTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putInstitutionTelephoneNumberTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"institutionTelephoneNumberTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_institutionTelephoneNumberTypeDescriptor" } } }, "required": true, "x-bodyName": "institutionTelephoneNumberTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "institutionTelephoneNumberTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInstitutionTelephoneNumberTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/institutionTelephoneNumberTypeDescriptors/deletes": { "get": { "tags": [ "institutionTelephoneNumberTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInstitutionTelephoneNumberTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_institutionTelephoneNumberTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/institutionTelephoneNumberTypeDescriptors/keyChanges": { "get": { "tags": [ "institutionTelephoneNumberTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInstitutionTelephoneNumberTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_institutionTelephoneNumberTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/institutionTelephoneNumberTypeDescriptors/partitions": { "get": { "tags": [ "institutionTelephoneNumberTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInstitutionTelephoneNumberTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/interactivityStyleDescriptors": { "get": { "tags": [ "interactivityStyleDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInteractivityStyleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_interactivityStyleDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "interactivityStyleDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInteractivityStyleDescriptor", "requestBody": { "description": "The JSON representation of the \"interactivityStyleDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interactivityStyleDescriptor" } } }, "required": true, "x-bodyName": "interactivityStyleDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interactivityStyleDescriptors/{id}": { "get": { "tags": [ "interactivityStyleDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInteractivityStyleDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interactivityStyleDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "interactivityStyleDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putInteractivityStyleDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"interactivityStyleDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interactivityStyleDescriptor" } } }, "required": true, "x-bodyName": "interactivityStyleDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "interactivityStyleDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInteractivityStyleDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interactivityStyleDescriptors/deletes": { "get": { "tags": [ "interactivityStyleDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInteractivityStyleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interactivityStyleDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interactivityStyleDescriptors/keyChanges": { "get": { "tags": [ "interactivityStyleDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInteractivityStyleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interactivityStyleDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interactivityStyleDescriptors/partitions": { "get": { "tags": [ "interactivityStyleDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInteractivityStyleDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/internetAccessDescriptors": { "get": { "tags": [ "internetAccessDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInternetAccessDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_internetAccessDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "internetAccessDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInternetAccessDescriptor", "requestBody": { "description": "The JSON representation of the \"internetAccessDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetAccessDescriptor" } } }, "required": true, "x-bodyName": "internetAccessDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/internetAccessDescriptors/{id}": { "get": { "tags": [ "internetAccessDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInternetAccessDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetAccessDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "internetAccessDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putInternetAccessDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"internetAccessDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetAccessDescriptor" } } }, "required": true, "x-bodyName": "internetAccessDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "internetAccessDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInternetAccessDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/internetAccessDescriptors/deletes": { "get": { "tags": [ "internetAccessDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInternetAccessDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_internetAccessDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/internetAccessDescriptors/keyChanges": { "get": { "tags": [ "internetAccessDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInternetAccessDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_internetAccessDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/internetAccessDescriptors/partitions": { "get": { "tags": [ "internetAccessDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInternetAccessDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/internetAccessTypeInResidenceDescriptors": { "get": { "tags": [ "internetAccessTypeInResidenceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInternetAccessTypeInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_internetAccessTypeInResidenceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "internetAccessTypeInResidenceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInternetAccessTypeInResidenceDescriptor", "requestBody": { "description": "The JSON representation of the \"internetAccessTypeInResidenceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetAccessTypeInResidenceDescriptor" } } }, "required": true, "x-bodyName": "internetAccessTypeInResidenceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { "get": { "tags": [ "internetAccessTypeInResidenceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInternetAccessTypeInResidenceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetAccessTypeInResidenceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "internetAccessTypeInResidenceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putInternetAccessTypeInResidenceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"internetAccessTypeInResidenceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetAccessTypeInResidenceDescriptor" } } }, "required": true, "x-bodyName": "internetAccessTypeInResidenceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "internetAccessTypeInResidenceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInternetAccessTypeInResidenceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/internetAccessTypeInResidenceDescriptors/deletes": { "get": { "tags": [ "internetAccessTypeInResidenceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInternetAccessTypeInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_internetAccessTypeInResidenceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/internetAccessTypeInResidenceDescriptors/keyChanges": { "get": { "tags": [ "internetAccessTypeInResidenceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInternetAccessTypeInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_internetAccessTypeInResidenceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/internetAccessTypeInResidenceDescriptors/partitions": { "get": { "tags": [ "internetAccessTypeInResidenceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInternetAccessTypeInResidenceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/internetPerformanceInResidenceDescriptors": { "get": { "tags": [ "internetPerformanceInResidenceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInternetPerformanceInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_internetPerformanceInResidenceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "internetPerformanceInResidenceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInternetPerformanceInResidenceDescriptor", "requestBody": { "description": "The JSON representation of the \"internetPerformanceInResidenceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetPerformanceInResidenceDescriptor" } } }, "required": true, "x-bodyName": "internetPerformanceInResidenceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { "get": { "tags": [ "internetPerformanceInResidenceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInternetPerformanceInResidenceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetPerformanceInResidenceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "internetPerformanceInResidenceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putInternetPerformanceInResidenceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"internetPerformanceInResidenceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_internetPerformanceInResidenceDescriptor" } } }, "required": true, "x-bodyName": "internetPerformanceInResidenceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "internetPerformanceInResidenceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInternetPerformanceInResidenceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/internetPerformanceInResidenceDescriptors/deletes": { "get": { "tags": [ "internetPerformanceInResidenceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInternetPerformanceInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_internetPerformanceInResidenceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/internetPerformanceInResidenceDescriptors/keyChanges": { "get": { "tags": [ "internetPerformanceInResidenceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInternetPerformanceInResidenceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_internetPerformanceInResidenceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/internetPerformanceInResidenceDescriptors/partitions": { "get": { "tags": [ "internetPerformanceInResidenceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInternetPerformanceInResidenceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/interventions": { "get": { "tags": [ "interventions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInterventions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "interventionIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "deliveryMethodDescriptor", "in": "query", "description": "The way in which an intervention was implemented.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "interventionClassDescriptor", "in": "query", "description": "The way in which an intervention is used: curriculum, supplement, or practice.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "beginDate", "in": "query", "description": "The start date for the intervention implementation. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The end date for the intervention implementation. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxDosage", "in": "query", "description": "The maximum duration of time in minutes that may be assigned for the intervention.", "schema": { "type": "integer", "format": "int32" } }, { "name": "minDosage", "in": "query", "description": "The minimum duration of time in minutes that may be assigned for the intervention.", "schema": { "type": "integer", "format": "int32" } }, { "name": "namespace", "in": "query", "description": "Namespace for the intervention.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_intervention" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "interventions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postIntervention", "requestBody": { "description": "The JSON representation of the \"intervention\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_intervention" } } }, "required": true, "x-bodyName": "intervention" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventions/{id}": { "get": { "tags": [ "interventions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInterventionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_intervention" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "interventions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"intervention\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_intervention" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "interventions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInterventionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventions/deletes": { "get": { "tags": [ "interventions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInterventions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventions/keyChanges": { "get": { "tags": [ "interventions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInterventions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventions/partitions": { "get": { "tags": [ "interventions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInterventionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "interventionIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "deliveryMethodDescriptor", "in": "query", "description": "The way in which an intervention was implemented.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "interventionClassDescriptor", "in": "query", "description": "The way in which an intervention is used: curriculum, supplement, or practice.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "beginDate", "in": "query", "description": "The start date for the intervention implementation. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "The end date for the intervention implementation. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxDosage", "in": "query", "description": "The maximum duration of time in minutes that may be assigned for the intervention.", "schema": { "type": "integer", "format": "int32" } }, { "name": "minDosage", "in": "query", "description": "The minimum duration of time in minutes that may be assigned for the intervention.", "schema": { "type": "integer", "format": "int32" } }, { "name": "namespace", "in": "query", "description": "Namespace for the intervention.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/interventionClassDescriptors": { "get": { "tags": [ "interventionClassDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInterventionClassDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_interventionClassDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "interventionClassDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInterventionClassDescriptor", "requestBody": { "description": "The JSON representation of the \"interventionClassDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionClassDescriptor" } } }, "required": true, "x-bodyName": "interventionClassDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventionClassDescriptors/{id}": { "get": { "tags": [ "interventionClassDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInterventionClassDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionClassDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "interventionClassDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putInterventionClassDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"interventionClassDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionClassDescriptor" } } }, "required": true, "x-bodyName": "interventionClassDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "interventionClassDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInterventionClassDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventionClassDescriptors/deletes": { "get": { "tags": [ "interventionClassDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInterventionClassDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionClassDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventionClassDescriptors/keyChanges": { "get": { "tags": [ "interventionClassDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInterventionClassDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionClassDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventionClassDescriptors/partitions": { "get": { "tags": [ "interventionClassDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInterventionClassDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/interventionEffectivenessRatingDescriptors": { "get": { "tags": [ "interventionEffectivenessRatingDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInterventionEffectivenessRatingDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_interventionEffectivenessRatingDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "interventionEffectivenessRatingDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInterventionEffectivenessRatingDescriptor", "requestBody": { "description": "The JSON representation of the \"interventionEffectivenessRatingDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionEffectivenessRatingDescriptor" } } }, "required": true, "x-bodyName": "interventionEffectivenessRatingDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { "get": { "tags": [ "interventionEffectivenessRatingDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInterventionEffectivenessRatingDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionEffectivenessRatingDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "interventionEffectivenessRatingDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putInterventionEffectivenessRatingDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"interventionEffectivenessRatingDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionEffectivenessRatingDescriptor" } } }, "required": true, "x-bodyName": "interventionEffectivenessRatingDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "interventionEffectivenessRatingDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInterventionEffectivenessRatingDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventionEffectivenessRatingDescriptors/deletes": { "get": { "tags": [ "interventionEffectivenessRatingDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInterventionEffectivenessRatingDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionEffectivenessRatingDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventionEffectivenessRatingDescriptors/keyChanges": { "get": { "tags": [ "interventionEffectivenessRatingDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInterventionEffectivenessRatingDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionEffectivenessRatingDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventionEffectivenessRatingDescriptors/partitions": { "get": { "tags": [ "interventionEffectivenessRatingDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInterventionEffectivenessRatingDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/interventionPrescriptions": { "get": { "tags": [ "interventionPrescriptions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInterventionPrescriptions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "interventionPrescriptionIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention prescription.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "deliveryMethodDescriptor", "in": "query", "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "interventionClassDescriptor", "in": "query", "description": "The way in which an intervention is used: curriculum, supplement, or practice.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxDosage", "in": "query", "description": "The maximum duration of time in minutes that is recommended for the intervention.", "schema": { "type": "integer", "format": "int32" } }, { "name": "minDosage", "in": "query", "description": "The minimum duration of time in minutes that is recommended for the intervention.", "schema": { "type": "integer", "format": "int32" } }, { "name": "namespace", "in": "query", "description": "Namespace for the intervention.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_interventionPrescription" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "interventionPrescriptions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInterventionPrescription", "requestBody": { "description": "The JSON representation of the \"interventionPrescription\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionPrescription" } } }, "required": true, "x-bodyName": "interventionPrescription" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventionPrescriptions/{id}": { "get": { "tags": [ "interventionPrescriptions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInterventionPrescriptionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionPrescription" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "interventionPrescriptions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"interventionPrescription\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionPrescription" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "interventionPrescriptions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInterventionPrescriptionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventionPrescriptions/deletes": { "get": { "tags": [ "interventionPrescriptions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInterventionPrescriptions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionPrescriptionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventionPrescriptions/keyChanges": { "get": { "tags": [ "interventionPrescriptions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInterventionPrescriptions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionPrescriptionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventionPrescriptions/partitions": { "get": { "tags": [ "interventionPrescriptions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInterventionPrescriptionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "interventionPrescriptionIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention prescription.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "deliveryMethodDescriptor", "in": "query", "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "interventionClassDescriptor", "in": "query", "description": "The way in which an intervention is used: curriculum, supplement, or practice.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxDosage", "in": "query", "description": "The maximum duration of time in minutes that is recommended for the intervention.", "schema": { "type": "integer", "format": "int32" } }, { "name": "minDosage", "in": "query", "description": "The minimum duration of time in minutes that is recommended for the intervention.", "schema": { "type": "integer", "format": "int32" } }, { "name": "namespace", "in": "query", "description": "Namespace for the intervention.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/interventionStudies": { "get": { "tags": [ "interventionStudies" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getInterventionStudies", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "interventionStudyIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention study.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "interventionPrescriptionEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "interventionPrescriptionIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention prescription.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "deliveryMethodDescriptor", "in": "query", "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "interventionClassDescriptor", "in": "query", "description": "The way in which an intervention is used: curriculum, supplement, or practice.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "participants", "in": "query", "description": "The number of participants observed in the study.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_interventionStudy" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "interventionStudies" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postInterventionStudy", "requestBody": { "description": "The JSON representation of the \"interventionStudy\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionStudy" } } }, "required": true, "x-bodyName": "interventionStudy" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventionStudies/{id}": { "get": { "tags": [ "interventionStudies" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getInterventionStudiesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionStudy" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "interventionStudies" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"interventionStudy\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_interventionStudy" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "interventionStudies" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteInterventionStudyById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/interventionStudies/deletes": { "get": { "tags": [ "interventionStudies" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesInterventionStudies", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionStudyDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventionStudies/keyChanges": { "get": { "tags": [ "interventionStudies" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesInterventionStudies", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_interventionStudyKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/interventionStudies/partitions": { "get": { "tags": [ "interventionStudies" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getInterventionStudiesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "interventionStudyIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention study.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "interventionPrescriptionEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "interventionPrescriptionIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an intervention prescription.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "deliveryMethodDescriptor", "in": "query", "description": "The way in which an intervention was implemented: individual, small group, whole class, or whole school.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "interventionClassDescriptor", "in": "query", "description": "The way in which an intervention is used: curriculum, supplement, or practice.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "participants", "in": "query", "description": "The number of participants observed in the study.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/languageDescriptors": { "get": { "tags": [ "languageDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLanguageDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_languageDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "languageDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLanguageDescriptor", "requestBody": { "description": "The JSON representation of the \"languageDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageDescriptor" } } }, "required": true, "x-bodyName": "languageDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/languageDescriptors/{id}": { "get": { "tags": [ "languageDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLanguageDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "languageDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLanguageDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"languageDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageDescriptor" } } }, "required": true, "x-bodyName": "languageDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "languageDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLanguageDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/languageDescriptors/deletes": { "get": { "tags": [ "languageDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLanguageDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_languageDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/languageDescriptors/keyChanges": { "get": { "tags": [ "languageDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLanguageDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_languageDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/languageDescriptors/partitions": { "get": { "tags": [ "languageDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLanguageDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/languageInstructionProgramServiceDescriptors": { "get": { "tags": [ "languageInstructionProgramServiceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLanguageInstructionProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_languageInstructionProgramServiceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "languageInstructionProgramServiceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLanguageInstructionProgramServiceDescriptor", "requestBody": { "description": "The JSON representation of the \"languageInstructionProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageInstructionProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "languageInstructionProgramServiceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { "get": { "tags": [ "languageInstructionProgramServiceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLanguageInstructionProgramServiceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageInstructionProgramServiceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "languageInstructionProgramServiceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLanguageInstructionProgramServiceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"languageInstructionProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageInstructionProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "languageInstructionProgramServiceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "languageInstructionProgramServiceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLanguageInstructionProgramServiceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/languageInstructionProgramServiceDescriptors/deletes": { "get": { "tags": [ "languageInstructionProgramServiceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLanguageInstructionProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_languageInstructionProgramServiceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/languageInstructionProgramServiceDescriptors/keyChanges": { "get": { "tags": [ "languageInstructionProgramServiceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLanguageInstructionProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_languageInstructionProgramServiceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/languageInstructionProgramServiceDescriptors/partitions": { "get": { "tags": [ "languageInstructionProgramServiceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLanguageInstructionProgramServiceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/languageUseDescriptors": { "get": { "tags": [ "languageUseDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLanguageUseDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_languageUseDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "languageUseDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLanguageUseDescriptor", "requestBody": { "description": "The JSON representation of the \"languageUseDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageUseDescriptor" } } }, "required": true, "x-bodyName": "languageUseDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/languageUseDescriptors/{id}": { "get": { "tags": [ "languageUseDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLanguageUseDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageUseDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "languageUseDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLanguageUseDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"languageUseDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_languageUseDescriptor" } } }, "required": true, "x-bodyName": "languageUseDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "languageUseDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLanguageUseDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/languageUseDescriptors/deletes": { "get": { "tags": [ "languageUseDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLanguageUseDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_languageUseDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/languageUseDescriptors/keyChanges": { "get": { "tags": [ "languageUseDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLanguageUseDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_languageUseDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/languageUseDescriptors/partitions": { "get": { "tags": [ "languageUseDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLanguageUseDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/learningStandards": { "get": { "tags": [ "learningStandards" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLearningStandards", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "learningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "parentLearningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "learningStandardCategoryDescriptor", "in": "query", "description": "An additional classification of the type of a specific learning standard.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "learningStandardScopeDescriptor", "in": "query", "description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "courseTitle", "in": "query", "description": "The official course title with which this learning standard is associated.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "description", "in": "query", "description": "The text of the statement. The textual content that either describes a specific competency such as \"Apply the Pythagorean Theorem to determine unknown side lengths in right triangles in real-world and mathematical problems in two and three dimensions.\" or describes a less granular group of competencies within the taxonomy of the standards document, e.g. \"Understand and apply the Pythagorean Theorem,\" or \"Geometry\".", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "learningStandardItemCode", "in": "query", "description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "namespace", "in": "query", "description": "The namespace of the organization or entity who governs the standard. It is recommended the namespaces observe a URI format and begin with a domain name under the governing organization or entity control.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "successCriteria", "in": "query", "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a learning standard. This criteria gives clear indications as to the degree to which learning is moving through the Zone or Proximal Development toward independent achievement of the learning standard.", "schema": { "maxLength": 150, "type": "string" } }, { "name": "uri", "in": "query", "description": "An unambiguous reference to the statement using a network-resolvable URI.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "contentStandardName", "in": "query", "description": "The name of the content standard, for example Common Core.", "schema": { "maxLength": 65, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a Learning Standard.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_learningStandard" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "learningStandards" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLearningStandard", "requestBody": { "description": "The JSON representation of the \"learningStandard\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandard" } } }, "required": true, "x-bodyName": "learningStandard" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandards/{id}": { "get": { "tags": [ "learningStandards" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLearningStandardsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandard" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "learningStandards" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"learningStandard\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandard" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "learningStandards" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLearningStandardById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandards/deletes": { "get": { "tags": [ "learningStandards" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLearningStandards", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandards/keyChanges": { "get": { "tags": [ "learningStandards" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLearningStandards", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandards/partitions": { "get": { "tags": [ "learningStandards" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLearningStandardsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "learningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "parentLearningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "learningStandardCategoryDescriptor", "in": "query", "description": "An additional classification of the type of a specific learning standard.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "learningStandardScopeDescriptor", "in": "query", "description": "Signals the scope of usage the standard. Does not necessarily relate the standard to the governing body.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "courseTitle", "in": "query", "description": "The official course title with which this learning standard is associated.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "description", "in": "query", "description": "The text of the statement. The textual content that either describes a specific competency such as \"Apply the Pythagorean Theorem to determine unknown side lengths in right triangles in real-world and mathematical problems in two and three dimensions.\" or describes a less granular group of competencies within the taxonomy of the standards document, e.g. \"Understand and apply the Pythagorean Theorem,\" or \"Geometry\".", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "learningStandardItemCode", "in": "query", "description": "A code designated by the promulgating body to identify the statement, e.g. 1.N.3 (usually not globally unique).", "schema": { "maxLength": 60, "type": "string" } }, { "name": "namespace", "in": "query", "description": "The namespace of the organization or entity who governs the standard. It is recommended the namespaces observe a URI format and begin with a domain name under the governing organization or entity control.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "successCriteria", "in": "query", "description": "One or more statements that describes the criteria used by teachers and students to check for attainment of a learning standard. This criteria gives clear indications as to the degree to which learning is moving through the Zone or Proximal Development toward independent achievement of the learning standard.", "schema": { "maxLength": 150, "type": "string" } }, { "name": "uri", "in": "query", "description": "An unambiguous reference to the statement using a network-resolvable URI.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "contentStandardName", "in": "query", "description": "The name of the content standard, for example Common Core.", "schema": { "maxLength": 65, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a Learning Standard.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/learningStandardCategoryDescriptors": { "get": { "tags": [ "learningStandardCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLearningStandardCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_learningStandardCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "learningStandardCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLearningStandardCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"learningStandardCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardCategoryDescriptor" } } }, "required": true, "x-bodyName": "learningStandardCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandardCategoryDescriptors/{id}": { "get": { "tags": [ "learningStandardCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLearningStandardCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "learningStandardCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLearningStandardCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"learningStandardCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardCategoryDescriptor" } } }, "required": true, "x-bodyName": "learningStandardCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "learningStandardCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLearningStandardCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandardCategoryDescriptors/deletes": { "get": { "tags": [ "learningStandardCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLearningStandardCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandardCategoryDescriptors/keyChanges": { "get": { "tags": [ "learningStandardCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLearningStandardCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandardCategoryDescriptors/partitions": { "get": { "tags": [ "learningStandardCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLearningStandardCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/learningStandardEquivalenceAssociations": { "get": { "tags": [ "learningStandardEquivalenceAssociations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLearningStandardEquivalenceAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "namespace", "in": "query", "description": "The namespace of the organization that has created and owns the association.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceLearningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "targetLearningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "learningStandardEquivalenceStrengthDescriptor", "in": "query", "description": "A measure that indicates the strength or quality of the equivalence relationship.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "effectiveDate", "in": "query", "description": "The date that the association is considered to be applicable or effective.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "learningStandardEquivalenceStrengthDescription", "in": "query", "description": "Captures supplemental information on the relationship. Recommended for use only when the match is partial.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_learningStandardEquivalenceAssociation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "learningStandardEquivalenceAssociations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLearningStandardEquivalenceAssociation", "requestBody": { "description": "The JSON representation of the \"learningStandardEquivalenceAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardEquivalenceAssociation" } } }, "required": true, "x-bodyName": "learningStandardEquivalenceAssociation" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandardEquivalenceAssociations/{id}": { "get": { "tags": [ "learningStandardEquivalenceAssociations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLearningStandardEquivalenceAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardEquivalenceAssociation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "learningStandardEquivalenceAssociations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"learningStandardEquivalenceAssociation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardEquivalenceAssociation" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "learningStandardEquivalenceAssociations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLearningStandardEquivalenceAssociationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandardEquivalenceAssociations/deletes": { "get": { "tags": [ "learningStandardEquivalenceAssociations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLearningStandardEquivalenceAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardEquivalenceAssociationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandardEquivalenceAssociations/keyChanges": { "get": { "tags": [ "learningStandardEquivalenceAssociations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLearningStandardEquivalenceAssociations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardEquivalenceAssociationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandardEquivalenceAssociations/partitions": { "get": { "tags": [ "learningStandardEquivalenceAssociations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLearningStandardEquivalenceAssociationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "namespace", "in": "query", "description": "The namespace of the organization that has created and owns the association.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceLearningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "targetLearningStandardId", "in": "query", "description": "The identifier for the specific learning standard (e.g., 111.15.3.1.A).", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "learningStandardEquivalenceStrengthDescriptor", "in": "query", "description": "A measure that indicates the strength or quality of the equivalence relationship.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "effectiveDate", "in": "query", "description": "The date that the association is considered to be applicable or effective.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "learningStandardEquivalenceStrengthDescription", "in": "query", "description": "Captures supplemental information on the relationship. Recommended for use only when the match is partial.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/learningStandardEquivalenceStrengthDescriptors": { "get": { "tags": [ "learningStandardEquivalenceStrengthDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLearningStandardEquivalenceStrengthDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_learningStandardEquivalenceStrengthDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "learningStandardEquivalenceStrengthDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLearningStandardEquivalenceStrengthDescriptor", "requestBody": { "description": "The JSON representation of the \"learningStandardEquivalenceStrengthDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardEquivalenceStrengthDescriptor" } } }, "required": true, "x-bodyName": "learningStandardEquivalenceStrengthDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { "get": { "tags": [ "learningStandardEquivalenceStrengthDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLearningStandardEquivalenceStrengthDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardEquivalenceStrengthDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "learningStandardEquivalenceStrengthDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLearningStandardEquivalenceStrengthDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"learningStandardEquivalenceStrengthDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardEquivalenceStrengthDescriptor" } } }, "required": true, "x-bodyName": "learningStandardEquivalenceStrengthDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "learningStandardEquivalenceStrengthDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLearningStandardEquivalenceStrengthDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandardEquivalenceStrengthDescriptors/deletes": { "get": { "tags": [ "learningStandardEquivalenceStrengthDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLearningStandardEquivalenceStrengthDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardEquivalenceStrengthDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandardEquivalenceStrengthDescriptors/keyChanges": { "get": { "tags": [ "learningStandardEquivalenceStrengthDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLearningStandardEquivalenceStrengthDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardEquivalenceStrengthDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandardEquivalenceStrengthDescriptors/partitions": { "get": { "tags": [ "learningStandardEquivalenceStrengthDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLearningStandardEquivalenceStrengthDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/learningStandardScopeDescriptors": { "get": { "tags": [ "learningStandardScopeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLearningStandardScopeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_learningStandardScopeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "learningStandardScopeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLearningStandardScopeDescriptor", "requestBody": { "description": "The JSON representation of the \"learningStandardScopeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardScopeDescriptor" } } }, "required": true, "x-bodyName": "learningStandardScopeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandardScopeDescriptors/{id}": { "get": { "tags": [ "learningStandardScopeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLearningStandardScopeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardScopeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "learningStandardScopeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLearningStandardScopeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"learningStandardScopeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_learningStandardScopeDescriptor" } } }, "required": true, "x-bodyName": "learningStandardScopeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "learningStandardScopeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLearningStandardScopeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/learningStandardScopeDescriptors/deletes": { "get": { "tags": [ "learningStandardScopeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLearningStandardScopeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardScopeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandardScopeDescriptors/keyChanges": { "get": { "tags": [ "learningStandardScopeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLearningStandardScopeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_learningStandardScopeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/learningStandardScopeDescriptors/partitions": { "get": { "tags": [ "learningStandardScopeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLearningStandardScopeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/levelOfEducationDescriptors": { "get": { "tags": [ "levelOfEducationDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLevelOfEducationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_levelOfEducationDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "levelOfEducationDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLevelOfEducationDescriptor", "requestBody": { "description": "The JSON representation of the \"levelOfEducationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_levelOfEducationDescriptor" } } }, "required": true, "x-bodyName": "levelOfEducationDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/levelOfEducationDescriptors/{id}": { "get": { "tags": [ "levelOfEducationDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLevelOfEducationDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_levelOfEducationDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "levelOfEducationDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLevelOfEducationDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"levelOfEducationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_levelOfEducationDescriptor" } } }, "required": true, "x-bodyName": "levelOfEducationDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "levelOfEducationDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLevelOfEducationDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/levelOfEducationDescriptors/deletes": { "get": { "tags": [ "levelOfEducationDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLevelOfEducationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_levelOfEducationDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/levelOfEducationDescriptors/keyChanges": { "get": { "tags": [ "levelOfEducationDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLevelOfEducationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_levelOfEducationDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/levelOfEducationDescriptors/partitions": { "get": { "tags": [ "levelOfEducationDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLevelOfEducationDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/licenseStatusDescriptors": { "get": { "tags": [ "licenseStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLicenseStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_licenseStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "licenseStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLicenseStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"licenseStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_licenseStatusDescriptor" } } }, "required": true, "x-bodyName": "licenseStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/licenseStatusDescriptors/{id}": { "get": { "tags": [ "licenseStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLicenseStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_licenseStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "licenseStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLicenseStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"licenseStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_licenseStatusDescriptor" } } }, "required": true, "x-bodyName": "licenseStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "licenseStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLicenseStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/licenseStatusDescriptors/deletes": { "get": { "tags": [ "licenseStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLicenseStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_licenseStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/licenseStatusDescriptors/keyChanges": { "get": { "tags": [ "licenseStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLicenseStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_licenseStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/licenseStatusDescriptors/partitions": { "get": { "tags": [ "licenseStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLicenseStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/licenseTypeDescriptors": { "get": { "tags": [ "licenseTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLicenseTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_licenseTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "licenseTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLicenseTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"licenseTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_licenseTypeDescriptor" } } }, "required": true, "x-bodyName": "licenseTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/licenseTypeDescriptors/{id}": { "get": { "tags": [ "licenseTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLicenseTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_licenseTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "licenseTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLicenseTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"licenseTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_licenseTypeDescriptor" } } }, "required": true, "x-bodyName": "licenseTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "licenseTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLicenseTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/licenseTypeDescriptors/deletes": { "get": { "tags": [ "licenseTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLicenseTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_licenseTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/licenseTypeDescriptors/keyChanges": { "get": { "tags": [ "licenseTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLicenseTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_licenseTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/licenseTypeDescriptors/partitions": { "get": { "tags": [ "licenseTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLicenseTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/limitedEnglishProficiencyDescriptors": { "get": { "tags": [ "limitedEnglishProficiencyDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLimitedEnglishProficiencyDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_limitedEnglishProficiencyDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "limitedEnglishProficiencyDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLimitedEnglishProficiencyDescriptor", "requestBody": { "description": "The JSON representation of the \"limitedEnglishProficiencyDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_limitedEnglishProficiencyDescriptor" } } }, "required": true, "x-bodyName": "limitedEnglishProficiencyDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { "get": { "tags": [ "limitedEnglishProficiencyDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLimitedEnglishProficiencyDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_limitedEnglishProficiencyDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "limitedEnglishProficiencyDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLimitedEnglishProficiencyDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"limitedEnglishProficiencyDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_limitedEnglishProficiencyDescriptor" } } }, "required": true, "x-bodyName": "limitedEnglishProficiencyDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "limitedEnglishProficiencyDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLimitedEnglishProficiencyDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/limitedEnglishProficiencyDescriptors/deletes": { "get": { "tags": [ "limitedEnglishProficiencyDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLimitedEnglishProficiencyDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_limitedEnglishProficiencyDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/limitedEnglishProficiencyDescriptors/keyChanges": { "get": { "tags": [ "limitedEnglishProficiencyDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLimitedEnglishProficiencyDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_limitedEnglishProficiencyDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/limitedEnglishProficiencyDescriptors/partitions": { "get": { "tags": [ "limitedEnglishProficiencyDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLimitedEnglishProficiencyDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localAccounts": { "get": { "tags": [ "localAccounts" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocalAccounts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "chartOfAccountIdentifier", "in": "query", "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", "schema": { "maxLength": 50, "type": "string" } }, { "name": "chartOfAccountEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "accountName", "in": "query", "description": "A descriptive name for the account.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localAccount" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localAccounts" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocalAccount", "requestBody": { "description": "The JSON representation of the \"localAccount\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localAccount" } } }, "required": true, "x-bodyName": "localAccount" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localAccounts/{id}": { "get": { "tags": [ "localAccounts" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocalAccountsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localAccount" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localAccounts" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localAccount\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localAccount" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localAccounts" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocalAccountById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localAccounts/deletes": { "get": { "tags": [ "localAccounts" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocalAccounts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localAccountDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localAccounts/keyChanges": { "get": { "tags": [ "localAccounts" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocalAccounts", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localAccountKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localAccounts/partitions": { "get": { "tags": [ "localAccounts" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocalAccountsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "chartOfAccountIdentifier", "in": "query", "description": "SEA populated code value for the valid combination of account dimensions under which financials are reported.", "schema": { "maxLength": 50, "type": "string" } }, { "name": "chartOfAccountEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "accountName", "in": "query", "description": "A descriptive name for the account.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localActuals": { "get": { "tags": [ "localActuals" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocalActuals", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localActual" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localActuals" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocalActual", "requestBody": { "description": "The JSON representation of the \"localActual\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localActual" } } }, "required": true, "x-bodyName": "localActual" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localActuals/{id}": { "get": { "tags": [ "localActuals" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocalActualsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localActual" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localActuals" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localActual\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localActual" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localActuals" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocalActualById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localActuals/deletes": { "get": { "tags": [ "localActuals" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocalActuals", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localActualDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localActuals/keyChanges": { "get": { "tags": [ "localActuals" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocalActuals", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localActualKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localActuals/partitions": { "get": { "tags": [ "localActuals" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocalActualsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localBudgets": { "get": { "tags": [ "localBudgets" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocalBudgets", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localBudget" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localBudgets" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocalBudget", "requestBody": { "description": "The JSON representation of the \"localBudget\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localBudget" } } }, "required": true, "x-bodyName": "localBudget" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localBudgets/{id}": { "get": { "tags": [ "localBudgets" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocalBudgetsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localBudget" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localBudgets" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localBudget\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localBudget" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localBudgets" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocalBudgetById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localBudgets/deletes": { "get": { "tags": [ "localBudgets" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocalBudgets", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localBudgetDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localBudgets/keyChanges": { "get": { "tags": [ "localBudgets" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocalBudgets", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localBudgetKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localBudgets/partitions": { "get": { "tags": [ "localBudgets" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocalBudgetsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localContractedStaffs": { "get": { "tags": [ "localContractedStaffs" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocalContractedStaffs", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "staffUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a staff.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localContractedStaff" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localContractedStaffs" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocalContractedStaff", "requestBody": { "description": "The JSON representation of the \"localContractedStaff\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localContractedStaff" } } }, "required": true, "x-bodyName": "localContractedStaff" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localContractedStaffs/{id}": { "get": { "tags": [ "localContractedStaffs" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocalContractedStaffsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localContractedStaff" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localContractedStaffs" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localContractedStaff\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localContractedStaff" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localContractedStaffs" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocalContractedStaffById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localContractedStaffs/deletes": { "get": { "tags": [ "localContractedStaffs" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocalContractedStaffs", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localContractedStaffDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localContractedStaffs/keyChanges": { "get": { "tags": [ "localContractedStaffs" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocalContractedStaffs", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localContractedStaffKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localContractedStaffs/partitions": { "get": { "tags": [ "localContractedStaffs" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocalContractedStaffsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "staffUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a staff.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localeDescriptors": { "get": { "tags": [ "localeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocaleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocaleDescriptor", "requestBody": { "description": "The JSON representation of the \"localeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localeDescriptor" } } }, "required": true, "x-bodyName": "localeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localeDescriptors/{id}": { "get": { "tags": [ "localeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocaleDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLocaleDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localeDescriptor" } } }, "required": true, "x-bodyName": "localeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocaleDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localeDescriptors/deletes": { "get": { "tags": [ "localeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocaleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localeDescriptors/keyChanges": { "get": { "tags": [ "localeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocaleDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localeDescriptors/partitions": { "get": { "tags": [ "localeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocaleDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localEducationAgencies": { "get": { "tags": [ "localEducationAgencies" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocalEducationAgencies", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "localEducationAgencyId", "in": "query", "description": "The identifier assigned to a local education agency. It must be distinct from any other identifier assigned to educational organizations, such as a SchoolId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationServiceCenterId", "in": "query", "description": "The identifier assigned to an education service center. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "parentLocalEducationAgencyId", "in": "query", "description": "The identifier assigned to a local education agency. It must be distinct from any other identifier assigned to educational organizations, such as a SchoolId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "stateEducationAgencyId", "in": "query", "description": "The identifier assigned to a state education agency. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "charterStatusDescriptor", "in": "query", "description": "A school or agency providing free public elementary or secondary education to eligible students under a specific charter granted by the state legislature or other appropriate authority and designated by such authority to be a charter school.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "localEducationAgencyCategoryDescriptor", "in": "query", "description": "The category of local education agency/district.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localEducationAgency" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localEducationAgencies" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocalEducationAgency", "requestBody": { "description": "The JSON representation of the \"localEducationAgency\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEducationAgency" } } }, "required": true, "x-bodyName": "localEducationAgency" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localEducationAgencies/{id}": { "get": { "tags": [ "localEducationAgencies" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocalEducationAgenciesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEducationAgency" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localEducationAgencies" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localEducationAgency\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEducationAgency" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localEducationAgencies" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocalEducationAgencyById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localEducationAgencies/deletes": { "get": { "tags": [ "localEducationAgencies" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocalEducationAgencies", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localEducationAgencyDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localEducationAgencies/keyChanges": { "get": { "tags": [ "localEducationAgencies" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocalEducationAgencies", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localEducationAgencyKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localEducationAgencies/partitions": { "get": { "tags": [ "localEducationAgencies" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocalEducationAgenciesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "localEducationAgencyId", "in": "query", "description": "The identifier assigned to a local education agency. It must be distinct from any other identifier assigned to educational organizations, such as a SchoolId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationServiceCenterId", "in": "query", "description": "The identifier assigned to an education service center. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "parentLocalEducationAgencyId", "in": "query", "description": "The identifier assigned to a local education agency. It must be distinct from any other identifier assigned to educational organizations, such as a SchoolId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "stateEducationAgencyId", "in": "query", "description": "The identifier assigned to a state education agency. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "charterStatusDescriptor", "in": "query", "description": "A school or agency providing free public elementary or secondary education to eligible students under a specific charter granted by the state legislature or other appropriate authority and designated by such authority to be a charter school.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "localEducationAgencyCategoryDescriptor", "in": "query", "description": "The category of local education agency/district.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localEducationAgencyCategoryDescriptors": { "get": { "tags": [ "localEducationAgencyCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocalEducationAgencyCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localEducationAgencyCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localEducationAgencyCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocalEducationAgencyCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"localEducationAgencyCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEducationAgencyCategoryDescriptor" } } }, "required": true, "x-bodyName": "localEducationAgencyCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { "get": { "tags": [ "localEducationAgencyCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocalEducationAgencyCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEducationAgencyCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localEducationAgencyCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putLocalEducationAgencyCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localEducationAgencyCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEducationAgencyCategoryDescriptor" } } }, "required": true, "x-bodyName": "localEducationAgencyCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localEducationAgencyCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocalEducationAgencyCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localEducationAgencyCategoryDescriptors/deletes": { "get": { "tags": [ "localEducationAgencyCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocalEducationAgencyCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localEducationAgencyCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localEducationAgencyCategoryDescriptors/keyChanges": { "get": { "tags": [ "localEducationAgencyCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocalEducationAgencyCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localEducationAgencyCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localEducationAgencyCategoryDescriptors/partitions": { "get": { "tags": [ "localEducationAgencyCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocalEducationAgencyCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localEncumbrances": { "get": { "tags": [ "localEncumbrances" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocalEncumbrances", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localEncumbrance" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localEncumbrances" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocalEncumbrance", "requestBody": { "description": "The JSON representation of the \"localEncumbrance\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEncumbrance" } } }, "required": true, "x-bodyName": "localEncumbrance" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localEncumbrances/{id}": { "get": { "tags": [ "localEncumbrances" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocalEncumbrancesById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEncumbrance" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localEncumbrances" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localEncumbrance\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localEncumbrance" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localEncumbrances" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocalEncumbranceById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localEncumbrances/deletes": { "get": { "tags": [ "localEncumbrances" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocalEncumbrances", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localEncumbranceDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localEncumbrances/keyChanges": { "get": { "tags": [ "localEncumbrances" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocalEncumbrances", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localEncumbranceKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localEncumbrances/partitions": { "get": { "tags": [ "localEncumbrances" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocalEncumbrancesPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/localPayrolls": { "get": { "tags": [ "localPayrolls" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocalPayrolls", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "staffUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a staff.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_localPayroll" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "localPayrolls" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocalPayroll", "requestBody": { "description": "The JSON representation of the \"localPayroll\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localPayroll" } } }, "required": true, "x-bodyName": "localPayroll" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localPayrolls/{id}": { "get": { "tags": [ "localPayrolls" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocalPayrollsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localPayroll" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "localPayrolls" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"localPayroll\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_localPayroll" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "localPayrolls" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocalPayrollById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/localPayrolls/deletes": { "get": { "tags": [ "localPayrolls" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocalPayrolls", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localPayrollDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localPayrolls/keyChanges": { "get": { "tags": [ "localPayrolls" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocalPayrolls", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_localPayrollKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/localPayrolls/partitions": { "get": { "tags": [ "localPayrolls" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocalPayrollsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "asOfDate", "in": "query", "description": "The date of the reported amount for the account.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "accountIdentifier", "in": "query", "description": "Code value for the valid combination of account dimensions by LEA under which financials are reported.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for the account.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "staffUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a staff.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "financialCollectionDescriptor", "in": "query", "description": "The accounting period or grouping for which the amount is collected.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "amount", "in": "query", "description": "Current balance for the account.", "schema": { "type": "number", "format": "double" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/locations": { "get": { "tags": [ "locations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getLocations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "classroomIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maximumNumberOfSeats", "in": "query", "description": "The most number of seats the class can maintain.", "schema": { "type": "integer", "format": "int32" } }, { "name": "optimalNumberOfSeats", "in": "query", "description": "The number of seats that is most favorable to the class.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_location" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "locations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postLocation", "requestBody": { "description": "The JSON representation of the \"location\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_location" } } }, "required": true, "x-bodyName": "location" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/locations/{id}": { "get": { "tags": [ "locations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_location" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "locations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, if natural key values are being updated by the JSON body, those changes will be applied to the resource and will also cascade through to dependent resources.", "operationId": "putLocation", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"location\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_location" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } }, "x-Ed-Fi-isUpdatable": true }, "delete": { "tags": [ "locations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteLocationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/locations/deletes": { "get": { "tags": [ "locations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesLocations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_locationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/locations/keyChanges": { "get": { "tags": [ "locations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesLocations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_locationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/locations/partitions": { "get": { "tags": [ "locations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getLocationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "classroomIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolId", "in": "query", "description": "The identifier assigned to a school. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maximumNumberOfSeats", "in": "query", "description": "The most number of seats the class can maintain.", "schema": { "type": "integer", "format": "int32" } }, { "name": "optimalNumberOfSeats", "in": "query", "description": "The number of seats that is most favorable to the class.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors": { "get": { "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getMagnetSpecialProgramEmphasisSchoolDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_magnetSpecialProgramEmphasisSchoolDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postMagnetSpecialProgramEmphasisSchoolDescriptor", "requestBody": { "description": "The JSON representation of the \"magnetSpecialProgramEmphasisSchoolDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_magnetSpecialProgramEmphasisSchoolDescriptor" } } }, "required": true, "x-bodyName": "magnetSpecialProgramEmphasisSchoolDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { "get": { "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getMagnetSpecialProgramEmphasisSchoolDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_magnetSpecialProgramEmphasisSchoolDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putMagnetSpecialProgramEmphasisSchoolDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"magnetSpecialProgramEmphasisSchoolDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_magnetSpecialProgramEmphasisSchoolDescriptor" } } }, "required": true, "x-bodyName": "magnetSpecialProgramEmphasisSchoolDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteMagnetSpecialProgramEmphasisSchoolDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/deletes": { "get": { "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesMagnetSpecialProgramEmphasisSchoolDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_magnetSpecialProgramEmphasisSchoolDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/keyChanges": { "get": { "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesMagnetSpecialProgramEmphasisSchoolDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_magnetSpecialProgramEmphasisSchoolDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/partitions": { "get": { "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getMagnetSpecialProgramEmphasisSchoolDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/mediumOfInstructionDescriptors": { "get": { "tags": [ "mediumOfInstructionDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getMediumOfInstructionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_mediumOfInstructionDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "mediumOfInstructionDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postMediumOfInstructionDescriptor", "requestBody": { "description": "The JSON representation of the \"mediumOfInstructionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_mediumOfInstructionDescriptor" } } }, "required": true, "x-bodyName": "mediumOfInstructionDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/mediumOfInstructionDescriptors/{id}": { "get": { "tags": [ "mediumOfInstructionDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getMediumOfInstructionDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_mediumOfInstructionDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "mediumOfInstructionDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putMediumOfInstructionDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"mediumOfInstructionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_mediumOfInstructionDescriptor" } } }, "required": true, "x-bodyName": "mediumOfInstructionDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "mediumOfInstructionDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteMediumOfInstructionDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/mediumOfInstructionDescriptors/deletes": { "get": { "tags": [ "mediumOfInstructionDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesMediumOfInstructionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_mediumOfInstructionDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/mediumOfInstructionDescriptors/keyChanges": { "get": { "tags": [ "mediumOfInstructionDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesMediumOfInstructionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_mediumOfInstructionDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/mediumOfInstructionDescriptors/partitions": { "get": { "tags": [ "mediumOfInstructionDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getMediumOfInstructionDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/methodCreditEarnedDescriptors": { "get": { "tags": [ "methodCreditEarnedDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getMethodCreditEarnedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_methodCreditEarnedDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "methodCreditEarnedDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postMethodCreditEarnedDescriptor", "requestBody": { "description": "The JSON representation of the \"methodCreditEarnedDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_methodCreditEarnedDescriptor" } } }, "required": true, "x-bodyName": "methodCreditEarnedDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/methodCreditEarnedDescriptors/{id}": { "get": { "tags": [ "methodCreditEarnedDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getMethodCreditEarnedDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_methodCreditEarnedDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "methodCreditEarnedDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putMethodCreditEarnedDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"methodCreditEarnedDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_methodCreditEarnedDescriptor" } } }, "required": true, "x-bodyName": "methodCreditEarnedDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "methodCreditEarnedDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteMethodCreditEarnedDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/methodCreditEarnedDescriptors/deletes": { "get": { "tags": [ "methodCreditEarnedDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesMethodCreditEarnedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_methodCreditEarnedDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/methodCreditEarnedDescriptors/keyChanges": { "get": { "tags": [ "methodCreditEarnedDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesMethodCreditEarnedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_methodCreditEarnedDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/methodCreditEarnedDescriptors/partitions": { "get": { "tags": [ "methodCreditEarnedDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getMethodCreditEarnedDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/migrantEducationProgramServiceDescriptors": { "get": { "tags": [ "migrantEducationProgramServiceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getMigrantEducationProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_migrantEducationProgramServiceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "migrantEducationProgramServiceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postMigrantEducationProgramServiceDescriptor", "requestBody": { "description": "The JSON representation of the \"migrantEducationProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_migrantEducationProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "migrantEducationProgramServiceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { "get": { "tags": [ "migrantEducationProgramServiceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getMigrantEducationProgramServiceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_migrantEducationProgramServiceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "migrantEducationProgramServiceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putMigrantEducationProgramServiceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"migrantEducationProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_migrantEducationProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "migrantEducationProgramServiceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "migrantEducationProgramServiceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteMigrantEducationProgramServiceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/migrantEducationProgramServiceDescriptors/deletes": { "get": { "tags": [ "migrantEducationProgramServiceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesMigrantEducationProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_migrantEducationProgramServiceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/migrantEducationProgramServiceDescriptors/keyChanges": { "get": { "tags": [ "migrantEducationProgramServiceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesMigrantEducationProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_migrantEducationProgramServiceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/migrantEducationProgramServiceDescriptors/partitions": { "get": { "tags": [ "migrantEducationProgramServiceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getMigrantEducationProgramServiceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/modelEntityDescriptors": { "get": { "tags": [ "modelEntityDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getModelEntityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_modelEntityDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "modelEntityDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postModelEntityDescriptor", "requestBody": { "description": "The JSON representation of the \"modelEntityDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_modelEntityDescriptor" } } }, "required": true, "x-bodyName": "modelEntityDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/modelEntityDescriptors/{id}": { "get": { "tags": [ "modelEntityDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getModelEntityDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_modelEntityDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "modelEntityDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putModelEntityDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"modelEntityDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_modelEntityDescriptor" } } }, "required": true, "x-bodyName": "modelEntityDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "modelEntityDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteModelEntityDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/modelEntityDescriptors/deletes": { "get": { "tags": [ "modelEntityDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesModelEntityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_modelEntityDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/modelEntityDescriptors/keyChanges": { "get": { "tags": [ "modelEntityDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesModelEntityDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_modelEntityDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/modelEntityDescriptors/partitions": { "get": { "tags": [ "modelEntityDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getModelEntityDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/monitoredDescriptors": { "get": { "tags": [ "monitoredDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getMonitoredDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_monitoredDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "monitoredDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postMonitoredDescriptor", "requestBody": { "description": "The JSON representation of the \"monitoredDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_monitoredDescriptor" } } }, "required": true, "x-bodyName": "monitoredDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/monitoredDescriptors/{id}": { "get": { "tags": [ "monitoredDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getMonitoredDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_monitoredDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "monitoredDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putMonitoredDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"monitoredDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_monitoredDescriptor" } } }, "required": true, "x-bodyName": "monitoredDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "monitoredDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteMonitoredDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/monitoredDescriptors/deletes": { "get": { "tags": [ "monitoredDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesMonitoredDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_monitoredDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/monitoredDescriptors/keyChanges": { "get": { "tags": [ "monitoredDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesMonitoredDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_monitoredDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/monitoredDescriptors/partitions": { "get": { "tags": [ "monitoredDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getMonitoredDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/neglectedOrDelinquentProgramDescriptors": { "get": { "tags": [ "neglectedOrDelinquentProgramDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getNeglectedOrDelinquentProgramDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_neglectedOrDelinquentProgramDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "neglectedOrDelinquentProgramDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postNeglectedOrDelinquentProgramDescriptor", "requestBody": { "description": "The JSON representation of the \"neglectedOrDelinquentProgramDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_neglectedOrDelinquentProgramDescriptor" } } }, "required": true, "x-bodyName": "neglectedOrDelinquentProgramDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { "get": { "tags": [ "neglectedOrDelinquentProgramDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getNeglectedOrDelinquentProgramDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_neglectedOrDelinquentProgramDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "neglectedOrDelinquentProgramDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putNeglectedOrDelinquentProgramDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"neglectedOrDelinquentProgramDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_neglectedOrDelinquentProgramDescriptor" } } }, "required": true, "x-bodyName": "neglectedOrDelinquentProgramDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "neglectedOrDelinquentProgramDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteNeglectedOrDelinquentProgramDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/neglectedOrDelinquentProgramDescriptors/deletes": { "get": { "tags": [ "neglectedOrDelinquentProgramDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesNeglectedOrDelinquentProgramDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_neglectedOrDelinquentProgramDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/neglectedOrDelinquentProgramDescriptors/keyChanges": { "get": { "tags": [ "neglectedOrDelinquentProgramDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesNeglectedOrDelinquentProgramDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_neglectedOrDelinquentProgramDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/neglectedOrDelinquentProgramDescriptors/partitions": { "get": { "tags": [ "neglectedOrDelinquentProgramDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getNeglectedOrDelinquentProgramDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors": { "get": { "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getNeglectedOrDelinquentProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_neglectedOrDelinquentProgramServiceDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postNeglectedOrDelinquentProgramServiceDescriptor", "requestBody": { "description": "The JSON representation of the \"neglectedOrDelinquentProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_neglectedOrDelinquentProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "neglectedOrDelinquentProgramServiceDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { "get": { "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getNeglectedOrDelinquentProgramServiceDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_neglectedOrDelinquentProgramServiceDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putNeglectedOrDelinquentProgramServiceDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"neglectedOrDelinquentProgramServiceDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_neglectedOrDelinquentProgramServiceDescriptor" } } }, "required": true, "x-bodyName": "neglectedOrDelinquentProgramServiceDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteNeglectedOrDelinquentProgramServiceDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/deletes": { "get": { "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesNeglectedOrDelinquentProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_neglectedOrDelinquentProgramServiceDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/keyChanges": { "get": { "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesNeglectedOrDelinquentProgramServiceDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_neglectedOrDelinquentProgramServiceDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/partitions": { "get": { "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getNeglectedOrDelinquentProgramServiceDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/networkPurposeDescriptors": { "get": { "tags": [ "networkPurposeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getNetworkPurposeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_networkPurposeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "networkPurposeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postNetworkPurposeDescriptor", "requestBody": { "description": "The JSON representation of the \"networkPurposeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_networkPurposeDescriptor" } } }, "required": true, "x-bodyName": "networkPurposeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/networkPurposeDescriptors/{id}": { "get": { "tags": [ "networkPurposeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getNetworkPurposeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_networkPurposeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "networkPurposeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putNetworkPurposeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"networkPurposeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_networkPurposeDescriptor" } } }, "required": true, "x-bodyName": "networkPurposeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "networkPurposeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteNetworkPurposeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/networkPurposeDescriptors/deletes": { "get": { "tags": [ "networkPurposeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesNetworkPurposeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_networkPurposeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/networkPurposeDescriptors/keyChanges": { "get": { "tags": [ "networkPurposeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesNetworkPurposeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_networkPurposeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/networkPurposeDescriptors/partitions": { "get": { "tags": [ "networkPurposeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getNetworkPurposeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/nonMedicalImmunizationExemptionDescriptors": { "get": { "tags": [ "nonMedicalImmunizationExemptionDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getNonMedicalImmunizationExemptionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_nonMedicalImmunizationExemptionDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "nonMedicalImmunizationExemptionDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postNonMedicalImmunizationExemptionDescriptor", "requestBody": { "description": "The JSON representation of the \"nonMedicalImmunizationExemptionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_nonMedicalImmunizationExemptionDescriptor" } } }, "required": true, "x-bodyName": "nonMedicalImmunizationExemptionDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/nonMedicalImmunizationExemptionDescriptors/{id}": { "get": { "tags": [ "nonMedicalImmunizationExemptionDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getNonMedicalImmunizationExemptionDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_nonMedicalImmunizationExemptionDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "nonMedicalImmunizationExemptionDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putNonMedicalImmunizationExemptionDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"nonMedicalImmunizationExemptionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_nonMedicalImmunizationExemptionDescriptor" } } }, "required": true, "x-bodyName": "nonMedicalImmunizationExemptionDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "nonMedicalImmunizationExemptionDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteNonMedicalImmunizationExemptionDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/nonMedicalImmunizationExemptionDescriptors/deletes": { "get": { "tags": [ "nonMedicalImmunizationExemptionDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesNonMedicalImmunizationExemptionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_nonMedicalImmunizationExemptionDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/nonMedicalImmunizationExemptionDescriptors/keyChanges": { "get": { "tags": [ "nonMedicalImmunizationExemptionDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesNonMedicalImmunizationExemptionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_nonMedicalImmunizationExemptionDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/nonMedicalImmunizationExemptionDescriptors/partitions": { "get": { "tags": [ "nonMedicalImmunizationExemptionDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getNonMedicalImmunizationExemptionDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/objectDimensions": { "get": { "tags": [ "objectDimensions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getObjectDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "code", "in": "query", "description": "The code representation of the account object dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account object dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account object dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_objectDimension" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "objectDimensions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postObjectDimension", "requestBody": { "description": "The JSON representation of the \"objectDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_objectDimension" } } }, "required": true, "x-bodyName": "objectDimension" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/objectDimensions/{id}": { "get": { "tags": [ "objectDimensions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getObjectDimensionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_objectDimension" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "objectDimensions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"objectDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_objectDimension" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "objectDimensions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteObjectDimensionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/objectDimensions/deletes": { "get": { "tags": [ "objectDimensions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesObjectDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_objectDimensionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/objectDimensions/keyChanges": { "get": { "tags": [ "objectDimensions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesObjectDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_objectDimensionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/objectDimensions/partitions": { "get": { "tags": [ "objectDimensions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getObjectDimensionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "code", "in": "query", "description": "The code representation of the account object dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account object dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account object dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/objectiveAssessments": { "get": { "tags": [ "objectiveAssessments" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getObjectiveAssessments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "parentIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "academicSubjectDescriptor", "in": "query", "description": "The subject area of the objective assessment.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the objective assessment (e.g., vocabulary, measurement, or geometry).", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxRawScore", "in": "query", "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.", "schema": { "type": "number", "format": "double" } }, { "name": "nomenclature", "in": "query", "description": "Reflects the specific nomenclature used for this level of objective assessment.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "percentOfAssessment", "in": "query", "description": "The percentage of the assessment that tests this objective.", "schema": { "type": "number", "format": "double" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_objectiveAssessment" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "objectiveAssessments" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postObjectiveAssessment", "requestBody": { "description": "The JSON representation of the \"objectiveAssessment\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_objectiveAssessment" } } }, "required": true, "x-bodyName": "objectiveAssessment" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/objectiveAssessments/{id}": { "get": { "tags": [ "objectiveAssessments" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getObjectiveAssessmentsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_objectiveAssessment" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "objectiveAssessments" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"objectiveAssessment\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_objectiveAssessment" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "objectiveAssessments" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteObjectiveAssessmentById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/objectiveAssessments/deletes": { "get": { "tags": [ "objectiveAssessments" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesObjectiveAssessments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_objectiveAssessmentDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/objectiveAssessments/keyChanges": { "get": { "tags": [ "objectiveAssessments" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesObjectiveAssessments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_objectiveAssessmentKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/objectiveAssessments/partitions": { "get": { "tags": [ "objectiveAssessments" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getObjectiveAssessmentsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "assessmentIdentifier", "in": "query", "description": "A unique number or alphanumeric code assigned to an assessment.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "namespace", "in": "query", "description": "Namespace for the assessment.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "parentIdentificationCode", "in": "query", "description": "A unique number or alphanumeric code assigned to an objective assessment by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "academicSubjectDescriptor", "in": "query", "description": "The subject area of the objective assessment.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the objective assessment (e.g., vocabulary, measurement, or geometry).", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "maxRawScore", "in": "query", "description": "The maximum raw score achievable across all assessment items that are correct and scored at the maximum.", "schema": { "type": "number", "format": "double" } }, { "name": "nomenclature", "in": "query", "description": "Reflects the specific nomenclature used for this level of objective assessment.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "percentOfAssessment", "in": "query", "description": "The percentage of the assessment that tests this objective.", "schema": { "type": "number", "format": "double" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/objectiveRatingLevelDescriptors": { "get": { "tags": [ "objectiveRatingLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getObjectiveRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_objectiveRatingLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "objectiveRatingLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postObjectiveRatingLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"objectiveRatingLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_objectiveRatingLevelDescriptor" } } }, "required": true, "x-bodyName": "objectiveRatingLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/objectiveRatingLevelDescriptors/{id}": { "get": { "tags": [ "objectiveRatingLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getObjectiveRatingLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_objectiveRatingLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "objectiveRatingLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putObjectiveRatingLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"objectiveRatingLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_objectiveRatingLevelDescriptor" } } }, "required": true, "x-bodyName": "objectiveRatingLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "objectiveRatingLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteObjectiveRatingLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/objectiveRatingLevelDescriptors/deletes": { "get": { "tags": [ "objectiveRatingLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesObjectiveRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_objectiveRatingLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/objectiveRatingLevelDescriptors/keyChanges": { "get": { "tags": [ "objectiveRatingLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesObjectiveRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_objectiveRatingLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/objectiveRatingLevelDescriptors/partitions": { "get": { "tags": [ "objectiveRatingLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getObjectiveRatingLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/openStaffPositions": { "get": { "tags": [ "openStaffPositions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getOpenStaffPositions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "requisitionNumber", "in": "query", "description": "The number or identifier assigned to an open staff position, typically a requisition number assigned by Human Resources.", "schema": { "maxLength": 20, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "employmentStatusDescriptor", "in": "query", "description": "Reflects the type of employment or contract desired for the position.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "postingResultDescriptor", "in": "query", "description": "Indication of whether the OpenStaffPosition was filled or retired without filling.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "programAssignmentDescriptor", "in": "query", "description": "The name of the program for which the open staff position will be assigned.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "staffClassificationDescriptor", "in": "query", "description": "The titles of employment, official status, or rank of education staff.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "datePosted", "in": "query", "description": "Date the open staff position was posted. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "datePostingRemoved", "in": "query", "description": "The date the posting was removed or filled. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "positionTitle", "in": "query", "description": "The descriptive name of an individual's position.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_openStaffPosition" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "openStaffPositions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postOpenStaffPosition", "requestBody": { "description": "The JSON representation of the \"openStaffPosition\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_openStaffPosition" } } }, "required": true, "x-bodyName": "openStaffPosition" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/openStaffPositions/{id}": { "get": { "tags": [ "openStaffPositions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getOpenStaffPositionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_openStaffPosition" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "openStaffPositions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"openStaffPosition\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_openStaffPosition" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "openStaffPositions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteOpenStaffPositionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/openStaffPositions/deletes": { "get": { "tags": [ "openStaffPositions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesOpenStaffPositions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_openStaffPositionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/openStaffPositions/keyChanges": { "get": { "tags": [ "openStaffPositions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesOpenStaffPositions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_openStaffPositionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/openStaffPositions/partitions": { "get": { "tags": [ "openStaffPositions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getOpenStaffPositionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "requisitionNumber", "in": "query", "description": "The number or identifier assigned to an open staff position, typically a requisition number assigned by Human Resources.", "schema": { "maxLength": 20, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "employmentStatusDescriptor", "in": "query", "description": "Reflects the type of employment or contract desired for the position.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "postingResultDescriptor", "in": "query", "description": "Indication of whether the OpenStaffPosition was filled or retired without filling.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "programAssignmentDescriptor", "in": "query", "description": "The name of the program for which the open staff position will be assigned.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "staffClassificationDescriptor", "in": "query", "description": "The titles of employment, official status, or rank of education staff.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "datePosted", "in": "query", "description": "Date the open staff position was posted. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "datePostingRemoved", "in": "query", "description": "The date the posting was removed or filled. 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.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "positionTitle", "in": "query", "description": "The descriptive name of an individual's position.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/operationalStatusDescriptors": { "get": { "tags": [ "operationalStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getOperationalStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_operationalStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "operationalStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postOperationalStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"operationalStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_operationalStatusDescriptor" } } }, "required": true, "x-bodyName": "operationalStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/operationalStatusDescriptors/{id}": { "get": { "tags": [ "operationalStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getOperationalStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_operationalStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "operationalStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putOperationalStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"operationalStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_operationalStatusDescriptor" } } }, "required": true, "x-bodyName": "operationalStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "operationalStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteOperationalStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/operationalStatusDescriptors/deletes": { "get": { "tags": [ "operationalStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesOperationalStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_operationalStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/operationalStatusDescriptors/keyChanges": { "get": { "tags": [ "operationalStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesOperationalStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_operationalStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/operationalStatusDescriptors/partitions": { "get": { "tags": [ "operationalStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getOperationalStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/operationalUnitDimensions": { "get": { "tags": [ "operationalUnitDimensions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getOperationalUnitDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "code", "in": "query", "description": "The code representation of the account operational unit dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account operational unit dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account operational unit dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_operationalUnitDimension" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "operationalUnitDimensions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postOperationalUnitDimension", "requestBody": { "description": "The JSON representation of the \"operationalUnitDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_operationalUnitDimension" } } }, "required": true, "x-bodyName": "operationalUnitDimension" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/operationalUnitDimensions/{id}": { "get": { "tags": [ "operationalUnitDimensions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getOperationalUnitDimensionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_operationalUnitDimension" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "operationalUnitDimensions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"operationalUnitDimension\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_operationalUnitDimension" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "operationalUnitDimensions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteOperationalUnitDimensionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/operationalUnitDimensions/deletes": { "get": { "tags": [ "operationalUnitDimensions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesOperationalUnitDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_operationalUnitDimensionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/operationalUnitDimensions/keyChanges": { "get": { "tags": [ "operationalUnitDimensions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesOperationalUnitDimensions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_operationalUnitDimensionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/operationalUnitDimensions/partitions": { "get": { "tags": [ "operationalUnitDimensions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getOperationalUnitDimensionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "code", "in": "query", "description": "The code representation of the account operational unit dimension.", "schema": { "maxLength": 16, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "fiscalYear", "in": "query", "description": "The fiscal year for which the account operational unit dimension is valid.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "codeName", "in": "query", "description": "A description of the account operational unit dimension.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/organizationDepartments": { "get": { "tags": [ "organizationDepartments" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getOrganizationDepartments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "organizationDepartmentId", "in": "query", "description": "The unique identification code for the organization department. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "parentEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "academicSubjectDescriptor", "in": "query", "description": "The intended major subject area of the department.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_organizationDepartment" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "organizationDepartments" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postOrganizationDepartment", "requestBody": { "description": "The JSON representation of the \"organizationDepartment\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_organizationDepartment" } } }, "required": true, "x-bodyName": "organizationDepartment" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/organizationDepartments/{id}": { "get": { "tags": [ "organizationDepartments" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getOrganizationDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_organizationDepartment" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "organizationDepartments" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"organizationDepartment\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_organizationDepartment" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "organizationDepartments" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteOrganizationDepartmentById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/organizationDepartments/deletes": { "get": { "tags": [ "organizationDepartments" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesOrganizationDepartments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_organizationDepartmentDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/organizationDepartments/keyChanges": { "get": { "tags": [ "organizationDepartments" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesOrganizationDepartments", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_organizationDepartmentKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/organizationDepartments/partitions": { "get": { "tags": [ "organizationDepartments" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getOrganizationDepartmentsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "organizationDepartmentId", "in": "query", "description": "The unique identification code for the organization department. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "parentEducationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" } }, { "name": "academicSubjectDescriptor", "in": "query", "description": "The intended major subject area of the department.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/otherNameTypeDescriptors": { "get": { "tags": [ "otherNameTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getOtherNameTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_otherNameTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "otherNameTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postOtherNameTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"otherNameTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_otherNameTypeDescriptor" } } }, "required": true, "x-bodyName": "otherNameTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/otherNameTypeDescriptors/{id}": { "get": { "tags": [ "otherNameTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getOtherNameTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_otherNameTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "otherNameTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putOtherNameTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"otherNameTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_otherNameTypeDescriptor" } } }, "required": true, "x-bodyName": "otherNameTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "otherNameTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteOtherNameTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/otherNameTypeDescriptors/deletes": { "get": { "tags": [ "otherNameTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesOtherNameTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_otherNameTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/otherNameTypeDescriptors/keyChanges": { "get": { "tags": [ "otherNameTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesOtherNameTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_otherNameTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/otherNameTypeDescriptors/partitions": { "get": { "tags": [ "otherNameTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getOtherNameTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/participationDescriptors": { "get": { "tags": [ "participationDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getParticipationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_participationDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "participationDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postParticipationDescriptor", "requestBody": { "description": "The JSON representation of the \"participationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_participationDescriptor" } } }, "required": true, "x-bodyName": "participationDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/participationDescriptors/{id}": { "get": { "tags": [ "participationDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getParticipationDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_participationDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "participationDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putParticipationDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"participationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_participationDescriptor" } } }, "required": true, "x-bodyName": "participationDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "participationDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteParticipationDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/participationDescriptors/deletes": { "get": { "tags": [ "participationDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesParticipationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_participationDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/participationDescriptors/keyChanges": { "get": { "tags": [ "participationDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesParticipationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_participationDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/participationDescriptors/partitions": { "get": { "tags": [ "participationDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getParticipationDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/participationStatusDescriptors": { "get": { "tags": [ "participationStatusDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getParticipationStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_participationStatusDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "participationStatusDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postParticipationStatusDescriptor", "requestBody": { "description": "The JSON representation of the \"participationStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_participationStatusDescriptor" } } }, "required": true, "x-bodyName": "participationStatusDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/participationStatusDescriptors/{id}": { "get": { "tags": [ "participationStatusDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getParticipationStatusDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_participationStatusDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "participationStatusDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putParticipationStatusDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"participationStatusDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_participationStatusDescriptor" } } }, "required": true, "x-bodyName": "participationStatusDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "participationStatusDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteParticipationStatusDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/participationStatusDescriptors/deletes": { "get": { "tags": [ "participationStatusDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesParticipationStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_participationStatusDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/participationStatusDescriptors/keyChanges": { "get": { "tags": [ "participationStatusDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesParticipationStatusDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_participationStatusDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/participationStatusDescriptors/partitions": { "get": { "tags": [ "participationStatusDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getParticipationStatusDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/performanceBaseConversionDescriptors": { "get": { "tags": [ "performanceBaseConversionDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPerformanceBaseConversionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_performanceBaseConversionDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "performanceBaseConversionDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPerformanceBaseConversionDescriptor", "requestBody": { "description": "The JSON representation of the \"performanceBaseConversionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_performanceBaseConversionDescriptor" } } }, "required": true, "x-bodyName": "performanceBaseConversionDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/performanceBaseConversionDescriptors/{id}": { "get": { "tags": [ "performanceBaseConversionDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPerformanceBaseConversionDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_performanceBaseConversionDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "performanceBaseConversionDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPerformanceBaseConversionDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"performanceBaseConversionDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_performanceBaseConversionDescriptor" } } }, "required": true, "x-bodyName": "performanceBaseConversionDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "performanceBaseConversionDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePerformanceBaseConversionDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/performanceBaseConversionDescriptors/deletes": { "get": { "tags": [ "performanceBaseConversionDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPerformanceBaseConversionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_performanceBaseConversionDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/performanceBaseConversionDescriptors/keyChanges": { "get": { "tags": [ "performanceBaseConversionDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPerformanceBaseConversionDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_performanceBaseConversionDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/performanceBaseConversionDescriptors/partitions": { "get": { "tags": [ "performanceBaseConversionDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPerformanceBaseConversionDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/performanceEvaluations": { "get": { "tags": [ "performanceEvaluations" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPerformanceEvaluations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "academicSubjectDescriptor", "in": "query", "description": "The description of the content or subject area of a performance evaluation.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "performanceEvaluationDescription", "in": "query", "description": "The long description of the Performance Evaluation.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_performanceEvaluation" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "performanceEvaluations" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPerformanceEvaluation", "requestBody": { "description": "The JSON representation of the \"performanceEvaluation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluation" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/performanceEvaluations/{id}": { "get": { "tags": [ "performanceEvaluations" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPerformanceEvaluationsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluation" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "performanceEvaluations" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPerformanceEvaluation", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"performanceEvaluation\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluation" } } }, "required": true, "x-bodyName": "performanceEvaluation" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "performanceEvaluations" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePerformanceEvaluationById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/performanceEvaluations/deletes": { "get": { "tags": [ "performanceEvaluations" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPerformanceEvaluations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_performanceEvaluationDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/performanceEvaluations/keyChanges": { "get": { "tags": [ "performanceEvaluations" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPerformanceEvaluations", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_performanceEvaluationKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/performanceEvaluations/partitions": { "get": { "tags": [ "performanceEvaluations" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPerformanceEvaluationsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "academicSubjectDescriptor", "in": "query", "description": "The description of the content or subject area of a performance evaluation.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "performanceEvaluationDescription", "in": "query", "description": "The long description of the Performance Evaluation.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/performanceEvaluationRatings": { "get": { "tags": [ "performanceEvaluationRatings" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPerformanceEvaluationRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "coteachingStyleObservedDescriptor", "in": "query", "description": "A type of co-teaching observed as part of the performance evaluation.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "performanceEvaluationRatingLevelDescriptor", "in": "query", "description": "The rating level achieved based upon the rating or score.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "actualDate", "in": "query", "description": "The month, day, and year on which the performance evaluation was conducted.", "schema": { "type": "string", "format": "date" } }, { "name": "actualDuration", "in": "query", "description": "The actual or estimated number of clock minutes during which the performance evaluation was conducted.", "schema": { "type": "integer", "format": "int32" } }, { "name": "actualTime", "in": "query", "description": "An indication of the the time at which the performance evaluation was conducted.", "schema": { "type": "string" } }, { "name": "announced", "in": "query", "description": "An indicator of whether the performance evaluation was announced or not.", "schema": { "type": "boolean" } }, { "name": "comments", "in": "query", "description": "Any comments about the performance evaluation to be captured.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "scheduleDate", "in": "query", "description": "The month, day, and year on which the performance evaluation was scheduled.", "schema": { "type": "string", "format": "date" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_performanceEvaluationRating" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "performanceEvaluationRatings" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPerformanceEvaluationRating", "requestBody": { "description": "The JSON representation of the \"performanceEvaluationRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationRating" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/performanceEvaluationRatings/{id}": { "get": { "tags": [ "performanceEvaluationRatings" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPerformanceEvaluationRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationRating" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "performanceEvaluationRatings" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPerformanceEvaluationRating", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"performanceEvaluationRating\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationRating" } } }, "required": true, "x-bodyName": "performanceEvaluationRating" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "performanceEvaluationRatings" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePerformanceEvaluationRatingById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/performanceEvaluationRatings/deletes": { "get": { "tags": [ "performanceEvaluationRatings" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPerformanceEvaluationRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_performanceEvaluationRatingDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/performanceEvaluationRatings/keyChanges": { "get": { "tags": [ "performanceEvaluationRatings" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPerformanceEvaluationRatings", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_performanceEvaluationRatingKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/performanceEvaluationRatings/partitions": { "get": { "tags": [ "performanceEvaluationRatings" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPerformanceEvaluationRatingsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "evaluationPeriodDescriptor", "in": "query", "description": "The period for the evaluation.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTitle", "in": "query", "description": "An assigned unique identifier for the performance evaluation.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "performanceEvaluationTypeDescriptor", "in": "query", "description": "The type of performance evaluation conducted.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "schoolYear", "in": "query", "description": "The identifier for the school year.", "schema": { "type": "integer", "format": "int32" }, "x-Ed-Fi-isIdentity": true }, { "name": "termDescriptor", "in": "query", "description": "The term for the session during the school year.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "coteachingStyleObservedDescriptor", "in": "query", "description": "A type of co-teaching observed as part of the performance evaluation.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "performanceEvaluationRatingLevelDescriptor", "in": "query", "description": "The rating level achieved based upon the rating or score.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "actualDate", "in": "query", "description": "The month, day, and year on which the performance evaluation was conducted.", "schema": { "type": "string", "format": "date" } }, { "name": "actualDuration", "in": "query", "description": "The actual or estimated number of clock minutes during which the performance evaluation was conducted.", "schema": { "type": "integer", "format": "int32" } }, { "name": "actualTime", "in": "query", "description": "An indication of the the time at which the performance evaluation was conducted.", "schema": { "type": "string" } }, { "name": "announced", "in": "query", "description": "An indicator of whether the performance evaluation was announced or not.", "schema": { "type": "boolean" } }, { "name": "comments", "in": "query", "description": "Any comments about the performance evaluation to be captured.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "scheduleDate", "in": "query", "description": "The month, day, and year on which the performance evaluation was scheduled.", "schema": { "type": "string", "format": "date" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/performanceEvaluationRatingLevelDescriptors": { "get": { "tags": [ "performanceEvaluationRatingLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPerformanceEvaluationRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_performanceEvaluationRatingLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "performanceEvaluationRatingLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPerformanceEvaluationRatingLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"performanceEvaluationRatingLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationRatingLevelDescriptor" } } }, "required": true, "x-bodyName": "performanceEvaluationRatingLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/performanceEvaluationRatingLevelDescriptors/{id}": { "get": { "tags": [ "performanceEvaluationRatingLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPerformanceEvaluationRatingLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationRatingLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "performanceEvaluationRatingLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPerformanceEvaluationRatingLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"performanceEvaluationRatingLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationRatingLevelDescriptor" } } }, "required": true, "x-bodyName": "performanceEvaluationRatingLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "performanceEvaluationRatingLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePerformanceEvaluationRatingLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/performanceEvaluationRatingLevelDescriptors/deletes": { "get": { "tags": [ "performanceEvaluationRatingLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPerformanceEvaluationRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_performanceEvaluationRatingLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/performanceEvaluationRatingLevelDescriptors/keyChanges": { "get": { "tags": [ "performanceEvaluationRatingLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPerformanceEvaluationRatingLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_performanceEvaluationRatingLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/performanceEvaluationRatingLevelDescriptors/partitions": { "get": { "tags": [ "performanceEvaluationRatingLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPerformanceEvaluationRatingLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/tpdm/performanceEvaluationTypeDescriptors": { "get": { "tags": [ "performanceEvaluationTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPerformanceEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tpdm_performanceEvaluationTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "performanceEvaluationTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPerformanceEvaluationTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"performanceEvaluationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationTypeDescriptor" } } }, "required": true, "x-bodyName": "performanceEvaluationTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/performanceEvaluationTypeDescriptors/{id}": { "get": { "tags": [ "performanceEvaluationTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPerformanceEvaluationTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "performanceEvaluationTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPerformanceEvaluationTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"performanceEvaluationTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tpdm_performanceEvaluationTypeDescriptor" } } }, "required": true, "x-bodyName": "performanceEvaluationTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "performanceEvaluationTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePerformanceEvaluationTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/tpdm/performanceEvaluationTypeDescriptors/deletes": { "get": { "tags": [ "performanceEvaluationTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPerformanceEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_performanceEvaluationTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/performanceEvaluationTypeDescriptors/keyChanges": { "get": { "tags": [ "performanceEvaluationTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPerformanceEvaluationTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_tpdm_performanceEvaluationTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/tpdm/performanceEvaluationTypeDescriptors/partitions": { "get": { "tags": [ "performanceEvaluationTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPerformanceEvaluationTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/performanceLevelDescriptors": { "get": { "tags": [ "performanceLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPerformanceLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_performanceLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "performanceLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPerformanceLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"performanceLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_performanceLevelDescriptor" } } }, "required": true, "x-bodyName": "performanceLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/performanceLevelDescriptors/{id}": { "get": { "tags": [ "performanceLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPerformanceLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_performanceLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "performanceLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPerformanceLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"performanceLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_performanceLevelDescriptor" } } }, "required": true, "x-bodyName": "performanceLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "performanceLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePerformanceLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/performanceLevelDescriptors/deletes": { "get": { "tags": [ "performanceLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPerformanceLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_performanceLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/performanceLevelDescriptors/keyChanges": { "get": { "tags": [ "performanceLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPerformanceLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_performanceLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/performanceLevelDescriptors/partitions": { "get": { "tags": [ "performanceLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPerformanceLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/people": { "get": { "tags": [ "people" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPeople", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_person" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "people" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPerson", "requestBody": { "description": "The JSON representation of the \"person\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_person" } } }, "required": true, "x-bodyName": "person" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/people/{id}": { "get": { "tags": [ "people" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPeopleById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_person" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "people" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPerson", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"person\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_person" } } }, "required": true, "x-bodyName": "person" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "people" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePersonById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/people/deletes": { "get": { "tags": [ "people" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPeople", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_personDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/people/keyChanges": { "get": { "tags": [ "people" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPeople", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_personKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/people/partitions": { "get": { "tags": [ "people" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPeoplePartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "sourceSystemDescriptor", "in": "query", "description": "This descriptor defines the originating record source system for the person.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "personId", "in": "query", "description": "A unique alphanumeric code assigned to a person.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/personalInformationVerificationDescriptors": { "get": { "tags": [ "personalInformationVerificationDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPersonalInformationVerificationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_personalInformationVerificationDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "personalInformationVerificationDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPersonalInformationVerificationDescriptor", "requestBody": { "description": "The JSON representation of the \"personalInformationVerificationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_personalInformationVerificationDescriptor" } } }, "required": true, "x-bodyName": "personalInformationVerificationDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/personalInformationVerificationDescriptors/{id}": { "get": { "tags": [ "personalInformationVerificationDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPersonalInformationVerificationDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_personalInformationVerificationDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "personalInformationVerificationDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPersonalInformationVerificationDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"personalInformationVerificationDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_personalInformationVerificationDescriptor" } } }, "required": true, "x-bodyName": "personalInformationVerificationDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "personalInformationVerificationDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePersonalInformationVerificationDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/personalInformationVerificationDescriptors/deletes": { "get": { "tags": [ "personalInformationVerificationDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPersonalInformationVerificationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_personalInformationVerificationDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/personalInformationVerificationDescriptors/keyChanges": { "get": { "tags": [ "personalInformationVerificationDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPersonalInformationVerificationDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_personalInformationVerificationDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/personalInformationVerificationDescriptors/partitions": { "get": { "tags": [ "personalInformationVerificationDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPersonalInformationVerificationDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/platformTypeDescriptors": { "get": { "tags": [ "platformTypeDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPlatformTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_platformTypeDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "platformTypeDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPlatformTypeDescriptor", "requestBody": { "description": "The JSON representation of the \"platformTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_platformTypeDescriptor" } } }, "required": true, "x-bodyName": "platformTypeDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/platformTypeDescriptors/{id}": { "get": { "tags": [ "platformTypeDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPlatformTypeDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_platformTypeDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "platformTypeDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPlatformTypeDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"platformTypeDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_platformTypeDescriptor" } } }, "required": true, "x-bodyName": "platformTypeDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "platformTypeDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePlatformTypeDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/platformTypeDescriptors/deletes": { "get": { "tags": [ "platformTypeDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPlatformTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_platformTypeDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/platformTypeDescriptors/keyChanges": { "get": { "tags": [ "platformTypeDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPlatformTypeDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_platformTypeDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/platformTypeDescriptors/partitions": { "get": { "tags": [ "platformTypeDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPlatformTypeDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/populationServedDescriptors": { "get": { "tags": [ "populationServedDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPopulationServedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_populationServedDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "populationServedDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPopulationServedDescriptor", "requestBody": { "description": "The JSON representation of the \"populationServedDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_populationServedDescriptor" } } }, "required": true, "x-bodyName": "populationServedDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/populationServedDescriptors/{id}": { "get": { "tags": [ "populationServedDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPopulationServedDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_populationServedDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "populationServedDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPopulationServedDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"populationServedDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_populationServedDescriptor" } } }, "required": true, "x-bodyName": "populationServedDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "populationServedDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePopulationServedDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/populationServedDescriptors/deletes": { "get": { "tags": [ "populationServedDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPopulationServedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_populationServedDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/populationServedDescriptors/keyChanges": { "get": { "tags": [ "populationServedDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPopulationServedDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_populationServedDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/populationServedDescriptors/partitions": { "get": { "tags": [ "populationServedDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPopulationServedDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/postingResultDescriptors": { "get": { "tags": [ "postingResultDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPostingResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_postingResultDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "postingResultDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPostingResultDescriptor", "requestBody": { "description": "The JSON representation of the \"postingResultDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postingResultDescriptor" } } }, "required": true, "x-bodyName": "postingResultDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postingResultDescriptors/{id}": { "get": { "tags": [ "postingResultDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPostingResultDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postingResultDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "postingResultDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPostingResultDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"postingResultDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postingResultDescriptor" } } }, "required": true, "x-bodyName": "postingResultDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "postingResultDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePostingResultDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postingResultDescriptors/deletes": { "get": { "tags": [ "postingResultDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPostingResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postingResultDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postingResultDescriptors/keyChanges": { "get": { "tags": [ "postingResultDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPostingResultDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postingResultDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postingResultDescriptors/partitions": { "get": { "tags": [ "postingResultDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPostingResultDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/postSecondaryEvents": { "get": { "tags": [ "postSecondaryEvents" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPostSecondaryEvents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "postSecondaryEventCategoryDescriptor", "in": "query", "description": "The post secondary event that is logged.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "eventDate", "in": "query", "description": "The date the event occurred or was recorded.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "postSecondaryInstitutionId", "in": "query", "description": "The ID of the post secondary institution. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_postSecondaryEvent" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "postSecondaryEvents" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPostSecondaryEvent", "requestBody": { "description": "The JSON representation of the \"postSecondaryEvent\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryEvent" } } }, "required": true, "x-bodyName": "postSecondaryEvent" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postSecondaryEvents/{id}": { "get": { "tags": [ "postSecondaryEvents" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPostSecondaryEventsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryEvent" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "postSecondaryEvents" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"postSecondaryEvent\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryEvent" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "postSecondaryEvents" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePostSecondaryEventById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postSecondaryEvents/deletes": { "get": { "tags": [ "postSecondaryEvents" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPostSecondaryEvents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postSecondaryEventDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postSecondaryEvents/keyChanges": { "get": { "tags": [ "postSecondaryEvents" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPostSecondaryEvents", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postSecondaryEventKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postSecondaryEvents/partitions": { "get": { "tags": [ "postSecondaryEvents" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPostSecondaryEventsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "postSecondaryEventCategoryDescriptor", "in": "query", "description": "The post secondary event that is logged.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "eventDate", "in": "query", "description": "The date the event occurred or was recorded.", "schema": { "type": "string", "format": "date" }, "x-Ed-Fi-isIdentity": true }, { "name": "studentUniqueId", "in": "query", "description": "A unique alphanumeric code assigned to a student.", "schema": { "maxLength": 32, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "postSecondaryInstitutionId", "in": "query", "description": "The ID of the post secondary institution. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/postSecondaryEventCategoryDescriptors": { "get": { "tags": [ "postSecondaryEventCategoryDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPostSecondaryEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_postSecondaryEventCategoryDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "postSecondaryEventCategoryDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPostSecondaryEventCategoryDescriptor", "requestBody": { "description": "The JSON representation of the \"postSecondaryEventCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryEventCategoryDescriptor" } } }, "required": true, "x-bodyName": "postSecondaryEventCategoryDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { "get": { "tags": [ "postSecondaryEventCategoryDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPostSecondaryEventCategoryDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryEventCategoryDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "postSecondaryEventCategoryDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPostSecondaryEventCategoryDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"postSecondaryEventCategoryDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryEventCategoryDescriptor" } } }, "required": true, "x-bodyName": "postSecondaryEventCategoryDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "postSecondaryEventCategoryDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePostSecondaryEventCategoryDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postSecondaryEventCategoryDescriptors/deletes": { "get": { "tags": [ "postSecondaryEventCategoryDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPostSecondaryEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postSecondaryEventCategoryDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postSecondaryEventCategoryDescriptors/keyChanges": { "get": { "tags": [ "postSecondaryEventCategoryDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPostSecondaryEventCategoryDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postSecondaryEventCategoryDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postSecondaryEventCategoryDescriptors/partitions": { "get": { "tags": [ "postSecondaryEventCategoryDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPostSecondaryEventCategoryDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/postSecondaryInstitutions": { "get": { "tags": [ "postSecondaryInstitutions" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPostSecondaryInstitutions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "postSecondaryInstitutionId", "in": "query", "description": "The ID of the post secondary institution. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "administrativeFundingControlDescriptor", "in": "query", "description": "A classification of whether a postsecondary institution is operated by publicly elected or appointed officials (public control) or by privately elected or appointed officials and derives its major source of funds from private sources (private control).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "postSecondaryInstitutionLevelDescriptor", "in": "query", "description": "A classification of whether a post secondary institution's highest level of offering is a program of 4-years or higher (4 year), 2-but-less-than 4-years (2 year), or less than 2-years.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_postSecondaryInstitution" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "postSecondaryInstitutions" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPostSecondaryInstitution", "requestBody": { "description": "The JSON representation of the \"postSecondaryInstitution\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryInstitution" } } }, "required": true, "x-bodyName": "postSecondaryInstitution" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postSecondaryInstitutions/{id}": { "get": { "tags": [ "postSecondaryInstitutions" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPostSecondaryInstitutionsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryInstitution" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "postSecondaryInstitutions" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural 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": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"postSecondaryInstitution\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryInstitution" } } }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "postSecondaryInstitutions" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePostSecondaryInstitutionById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postSecondaryInstitutions/deletes": { "get": { "tags": [ "postSecondaryInstitutions" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPostSecondaryInstitutions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postSecondaryInstitutionDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postSecondaryInstitutions/keyChanges": { "get": { "tags": [ "postSecondaryInstitutions" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPostSecondaryInstitutions", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postSecondaryInstitutionKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postSecondaryInstitutions/partitions": { "get": { "tags": [ "postSecondaryInstitutions" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPostSecondaryInstitutionsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "postSecondaryInstitutionId", "in": "query", "description": "The ID of the post secondary institution. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "administrativeFundingControlDescriptor", "in": "query", "description": "A classification of whether a postsecondary institution is operated by publicly elected or appointed officials (public control) or by privately elected or appointed officials and derives its major source of funds from private sources (private control).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "postSecondaryInstitutionLevelDescriptor", "in": "query", "description": "A classification of whether a post secondary institution's highest level of offering is a program of 4-years or higher (4 year), 2-but-less-than 4-years (2 year), or less than 2-years.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "operationalStatusDescriptor", "in": "query", "description": "The current operational status of the education organization (e.g., active, inactive).", "schema": { "maxLength": 306, "type": "string" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "nameOfInstitution", "in": "query", "description": "The full, legally accepted name of the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "shortNameOfInstitution", "in": "query", "description": "A short name for the institution.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "webSite", "in": "query", "description": "The public web site address (URL) for the education organization.", "schema": { "maxLength": 255, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } }, { "name": "educationOrganizationIdentificationSystemDescriptor", "in": "query", "description": "The school system, state, or agency assigning the identification code.", "schema": { "maxLength": 306, "type": "string" } }, { "name": "identificationCode", "in": "query", "description": "A unique number or alphanumeric code that is assigned to an education organization by a school, school system, state, or other agency or entity.", "schema": { "maxLength": 60, "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/postSecondaryInstitutionLevelDescriptors": { "get": { "tags": [ "postSecondaryInstitutionLevelDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPostSecondaryInstitutionLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_postSecondaryInstitutionLevelDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "postSecondaryInstitutionLevelDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPostSecondaryInstitutionLevelDescriptor", "requestBody": { "description": "The JSON representation of the \"postSecondaryInstitutionLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryInstitutionLevelDescriptor" } } }, "required": true, "x-bodyName": "postSecondaryInstitutionLevelDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { "get": { "tags": [ "postSecondaryInstitutionLevelDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPostSecondaryInstitutionLevelDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryInstitutionLevelDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "postSecondaryInstitutionLevelDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPostSecondaryInstitutionLevelDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"postSecondaryInstitutionLevelDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_postSecondaryInstitutionLevelDescriptor" } } }, "required": true, "x-bodyName": "postSecondaryInstitutionLevelDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "postSecondaryInstitutionLevelDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePostSecondaryInstitutionLevelDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/postSecondaryInstitutionLevelDescriptors/deletes": { "get": { "tags": [ "postSecondaryInstitutionLevelDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPostSecondaryInstitutionLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postSecondaryInstitutionLevelDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postSecondaryInstitutionLevelDescriptors/keyChanges": { "get": { "tags": [ "postSecondaryInstitutionLevelDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPostSecondaryInstitutionLevelDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_postSecondaryInstitutionLevelDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/postSecondaryInstitutionLevelDescriptors/partitions": { "get": { "tags": [ "postSecondaryInstitutionLevelDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPostSecondaryInstitutionLevelDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/primaryLearningDeviceAccessDescriptors": { "get": { "tags": [ "primaryLearningDeviceAccessDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPrimaryLearningDeviceAccessDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceAccessDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "primaryLearningDeviceAccessDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPrimaryLearningDeviceAccessDescriptor", "requestBody": { "description": "The JSON representation of the \"primaryLearningDeviceAccessDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceAccessDescriptor" } } }, "required": true, "x-bodyName": "primaryLearningDeviceAccessDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { "get": { "tags": [ "primaryLearningDeviceAccessDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPrimaryLearningDeviceAccessDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceAccessDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "primaryLearningDeviceAccessDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPrimaryLearningDeviceAccessDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"primaryLearningDeviceAccessDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceAccessDescriptor" } } }, "required": true, "x-bodyName": "primaryLearningDeviceAccessDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "primaryLearningDeviceAccessDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePrimaryLearningDeviceAccessDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/primaryLearningDeviceAccessDescriptors/deletes": { "get": { "tags": [ "primaryLearningDeviceAccessDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPrimaryLearningDeviceAccessDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_primaryLearningDeviceAccessDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/primaryLearningDeviceAccessDescriptors/keyChanges": { "get": { "tags": [ "primaryLearningDeviceAccessDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPrimaryLearningDeviceAccessDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_primaryLearningDeviceAccessDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/primaryLearningDeviceAccessDescriptors/partitions": { "get": { "tags": [ "primaryLearningDeviceAccessDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPrimaryLearningDeviceAccessDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors": { "get": { "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPrimaryLearningDeviceAwayFromSchoolDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceAwayFromSchoolDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPrimaryLearningDeviceAwayFromSchoolDescriptor", "requestBody": { "description": "The JSON representation of the \"primaryLearningDeviceAwayFromSchoolDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceAwayFromSchoolDescriptor" } } }, "required": true, "x-bodyName": "primaryLearningDeviceAwayFromSchoolDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { "get": { "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPrimaryLearningDeviceAwayFromSchoolDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceAwayFromSchoolDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPrimaryLearningDeviceAwayFromSchoolDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"primaryLearningDeviceAwayFromSchoolDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceAwayFromSchoolDescriptor" } } }, "required": true, "x-bodyName": "primaryLearningDeviceAwayFromSchoolDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePrimaryLearningDeviceAwayFromSchoolDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/deletes": { "get": { "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPrimaryLearningDeviceAwayFromSchoolDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_primaryLearningDeviceAwayFromSchoolDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/keyChanges": { "get": { "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPrimaryLearningDeviceAwayFromSchoolDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_primaryLearningDeviceAwayFromSchoolDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/partitions": { "get": { "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPrimaryLearningDeviceAwayFromSchoolDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/primaryLearningDeviceProviderDescriptors": { "get": { "tags": [ "primaryLearningDeviceProviderDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPrimaryLearningDeviceProviderDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceProviderDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "primaryLearningDeviceProviderDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postPrimaryLearningDeviceProviderDescriptor", "requestBody": { "description": "The JSON representation of the \"primaryLearningDeviceProviderDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceProviderDescriptor" } } }, "required": true, "x-bodyName": "primaryLearningDeviceProviderDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { "get": { "tags": [ "primaryLearningDeviceProviderDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getPrimaryLearningDeviceProviderDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceProviderDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "primaryLearningDeviceProviderDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putPrimaryLearningDeviceProviderDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"primaryLearningDeviceProviderDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_primaryLearningDeviceProviderDescriptor" } } }, "required": true, "x-bodyName": "primaryLearningDeviceProviderDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "primaryLearningDeviceProviderDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deletePrimaryLearningDeviceProviderDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/primaryLearningDeviceProviderDescriptors/deletes": { "get": { "tags": [ "primaryLearningDeviceProviderDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesPrimaryLearningDeviceProviderDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_primaryLearningDeviceProviderDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/primaryLearningDeviceProviderDescriptors/keyChanges": { "get": { "tags": [ "primaryLearningDeviceProviderDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesPrimaryLearningDeviceProviderDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_primaryLearningDeviceProviderDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/primaryLearningDeviceProviderDescriptors/partitions": { "get": { "tags": [ "primaryLearningDeviceProviderDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getPrimaryLearningDeviceProviderDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/proficiencyDescriptors": { "get": { "tags": [ "proficiencyDescriptors" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getProficiencyDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "headers": { "Next-Page-Token": { "description": "A token that can be used to retrieve the next contiguous page of items. If not present, it indicates that there are no more items in the current cursor paging context (which is the current partition if the starting token was obtained using the partitions endpoint).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/edFi_proficiencyDescriptor" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "post": { "tags": [ "proficiencyDescriptors" ], "summary": "Creates or updates resources based on the natural key values of the supplied resource.", "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": "postProficiencyDescriptor", "requestBody": { "description": "The JSON representation of the \"proficiencyDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_proficiencyDescriptor" } } }, "required": true, "x-bodyName": "proficiencyDescriptor" }, "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. When the Use-Snapshot header is set to true, the method is not allowed." }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/proficiencyDescriptors/{id}": { "get": { "tags": [ "proficiencyDescriptors" ], "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", "description": "This GET operation retrieves a resource by the specified resource identifier.", "operationId": "getProficiencyDescriptorsById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/If-None-Match" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_proficiencyDescriptor" } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } }, "put": { "tags": [ "proficiencyDescriptors" ], "summary": "Updates a resource based on the resource identifier.", "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", "operationId": "putProficiencyDescriptor", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.", "schema": { "type": "string" } } ], "requestBody": { "description": "The JSON representation of the \"proficiencyDescriptor\" resource to be created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edFi_proficiencyDescriptor" } } }, "required": true, "x-bodyName": "proficiencyDescriptor" }, "responses": { "204": { "$ref": "#/components/responses/Updated" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } }, "delete": { "tags": [ "proficiencyDescriptors" ], "summary": "Deletes an existing resource using the resource identifier.", "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", "operationId": "deleteProficiencyDescriptorById", "parameters": [ { "name": "id", "in": "path", "description": "A resource identifier that uniquely identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" }, "400": { "$ref": "#/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" }, "500": { "$ref": "#/components/responses/Error" } } } }, "/ed-fi/proficiencyDescriptors/deletes": { "get": { "tags": [ "proficiencyDescriptors" ], "summary": "Retrieves deleted resources based on change version.", "description": "This operation is used to retrieve identifying information about resources that have been deleted.", "operationId": "deletesProficiencyDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_proficiencyDescriptorDelete" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/proficiencyDescriptors/keyChanges": { "get": { "tags": [ "proficiencyDescriptors" ], "summary": "Retrieves resources key changes based on change version.", "description": "This operation is used to retrieve identifying information about resources whose key values have been changed.", "operationId": "keyChangesProficiencyDescriptors", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "description": "The requested resource was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/trackedChanges_edFi_proficiencyDescriptorKeyChange" } } } } }, "304": { "$ref": "#/components/responses/NotModified" }, "404": { "$ref": "#/components/responses/NotFoundUseSnapshot" } } } }, "/ed-fi/proficiencyDescriptors/partitions": { "get": { "tags": [ "proficiencyDescriptors" ], "summary": "Retrieves a set of page tokens to be used for efficient client-side parallel processing.", "description": "Computes an evenly distributed set of partitions over the accessible data and returns a set of page tokens, each representing the first page of one of the partitions.", "operationId": "getProficiencyDescriptorsPartitions", "parameters": [ { "$ref": "#/components/parameters/numberOfPartitions" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "name": "codeValue", "in": "query", "description": "A code or abbreviation that is used to refer to the descriptor.", "schema": { "maxLength": 50, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "description", "in": "query", "description": "The description of the descriptor.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "effectiveBeginDate", "in": "query", "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", "schema": { "type": "string", "format": "date" } }, { "name": "effectiveEndDate", "in": "query", "description": "The end date of the period when the descriptor is in effect.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "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.", "schema": { "maxLength": 255, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "shortDescription", "in": "query", "description": "A shortened description for the descriptor.", "schema": { "maxLength": 75, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Error" }, "200": { "$ref": "#/components/responses/Partitions" } } } }, "/ed-fi/programs": { "get": { "tags": [ "programs" ], "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", "description": "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).", "operationId": "getPrograms", "parameters": [ { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/MinChangeVersion" }, { "$ref": "#/components/parameters/MaxChangeVersion" }, { "$ref": "#/components/parameters/totalCount" }, { "name": "programTypeDescriptor", "in": "query", "description": "The type of program.", "schema": { "maxLength": 306, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "programName", "in": "query", "description": "The formal name of the program of instruction, training, services, or benefits available through federal, state, or local agencies.", "schema": { "maxLength": 60, "type": "string" }, "x-Ed-Fi-isIdentity": true }, { "name": "educationOrganizationId", "in": "query", "description": "The identifier assigned to an education organization.", "schema": { "type": "integer", "format": "int64" }, "x-Ed-Fi-isIdentity": true }, { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "programId", "in": "query", "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", "schema": { "maxLength": 20, "type": "string" } }, { "name": "Use-Snapshot", "in": "header", "description": "Indicates if the configured Snapshot should be used.", "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/Err