Ed-Fi RFC 25 - Open API Spec
- Eric Jansson
- Ian Christopher (Deactivated)
Owned by Eric Jansson
This page contains the full Open API spec listing for the proposed ED-FI RFC 25 - SURVEY API.Â
Open API JSON
{
"swagger": "2.0",
"basePath": "/",
"consumes": [
"application/json"
],
"definitions": {
"edFi_survey": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"namespace": {
"description": "Namespace for the Survey.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 255,
"type": "string"
},
"surveyIdentifier": {
"description": "The unique survey identifier from the survey tool.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 64,
"type": "string"
},
"educationOrganizationReference": {
"$ref": "#/definitions/edFi_educationOrganizationReference"
},
"schoolYearTypeReference": {
"$ref": "#/definitions/edFi_schoolYearTypeReference"
},
"sessionReference": {
"$ref": "#/definitions/edFi_sessionReference"
},
"numberAdministered": {
"description": "Number of persons to whom this survey was administered.",
"format": "int",
"type": "integer"
},
"surveyCategoryDescriptor": {
"description": "The Category or Type of Survey.",
"maxLength": 306,
"type": "string"
},
"surveyTitle": {
"description": "The title of the survey.",
"maxLength": 255,
"type": "string"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"namespace",
"surveyIdentifier",
"id",
"surveyTitle",
"schoolYearTypeReference"
],
"type": "object"
},
"edFi_surveyCourseAssociation": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"courseReference": {
"$ref": "#/definitions/edFi_courseReference"
},
"surveyReference": {
"$ref": "#/definitions/edFi_surveyReference"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"courseReference",
"surveyReference"
],
"type": "object"
},
"edFi_surveyProgramAssociation": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"programReference": {
"$ref": "#/definitions/edFi_programReference"
},
"surveyReference": {
"$ref": "#/definitions/edFi_surveyReference"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"programReference",
"surveyReference"
],
"type": "object"
},
"edFi_surveyQuestion": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"questionCode": {
"description": "The identifying code for the question, unique for the survey.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 64,
"type": "string"
},
"surveyReference": {
"$ref": "#/definitions/edFi_surveyReference"
},
"surveySectionReference": {
"$ref": "#/definitions/edFi_surveySectionReference"
},
"matrices": {
"description": "An unordered collection of surveyQuestionMatrices. Information about the matrix element in the survey",
"items": {
"$ref": "#/definitions/edFi_surveyQuestionMatrix"
},
"type": "array"
},
"questionFormDescriptor": {
"description": "The form of question: 1) Radio box: multiple choice, single selection; 2) Checkbox: Multiple choice, multiple selection; 3) Dropdown: multiple choice, single selection; 4) Matrix, numeric rating scale; 5) Matrix of dropdowns; 6) Ranking; 7) Single textbook; 8) Matrix of text boxes",
"maxLength": 306,
"type": "string"
},
"questionText": {
"description": "The text of the question.",
"maxLength": 512,
"type": "string"
},
"responseChoices": {
"description": "An unordered collection of surveyQuestionResponseChoices. The optional list of possible responses to a survey question.",
"items": {
"$ref": "#/definitions/edFi_surveyQuestionResponseChoice"
},
"type": "array"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"questionCode",
"questionFormDescriptor",
"id",
"questionText",
"surveyReference"
],
"type": "object"
},
"edFi_surveyQuestionMatrix": {
"properties": {
"matrixElement": {
"description": "For matrix questions, the text identifying each row of the matrix.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 255,
"type": "string"
},
"maxRawScore": {
"description": "The maximum score possible on a survey.",
"format": "int",
"type": "integer"
},
"minRawScore": {
"description": "The minimum score possible on a survey.",
"format": "int",
"type": "integer"
}
},
"required": [
"matrixElement"
],
"type": "object"
},
"edFi_surveyQuestionReference": {
"properties": {
"namespace": {
"description": "Namespace for the Survey.",
"maxLength": 255,
"type": "string"
},
"questionCode": {
"description": "The identifying code for the question, unique for the survey.",
"maxLength": 64,
"type": "string"
},
"surveyIdentifier": {
"description": "The unique survey identifier from the survey tool.",
"maxLength": 64,
"type": "string"
}
},
"required": [
"namespace",
"questionCode",
"surveyIdentifier"
],
"type": "object"
},
"edFi_surveyQuestionResponse": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"surveyQuestionReference": {
"$ref": "#/definitions/edFi_surveyQuestionReference"
},
"surveyResponseReference": {
"$ref": "#/definitions/edFi_surveyResponseReference"
},
"comment": {
"description": "Additional information provided by the responder about the question in the survey.",
"maxLength": 1024,
"type": "string"
},
"noResponse": {
"description": "Indicates there was no response to the question.",
"type": "boolean"
},
"surveyQuestionMatrixElementResponses": {
"description": "An unordered collection of surveyQuestionResponseSurveyQuestionMatrixElementResponses. For matrix questions, the response for each row of the matrix.",
"items": {
"$ref": "#/definitions/edFi_surveyQuestionResponseSurveyQuestionMatrixElementResponse"
},
"type": "array"
},
"values": {
"description": "An unordered collection of surveyQuestionResponseValues. For free-form, single- or multiple-selection questions, one or more responses.",
"items": {
"$ref": "#/definitions/edFi_surveyQuestionResponseValue"
},
"type": "array"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"surveyQuestionReference",
"surveyResponseReference"
],
"type": "object"
},
"edFi_surveyQuestionResponseChoice": {
"properties": {
"sortOrder": {
"description": "Sort order of this ResponseChoice within the complete list of choices attached to a SurveyQuestion. If sort order doesn't apply, the value of NumericValue or a unique, possibly sequential numeric value.",
"format": "int",
"x-Ed-Fi-isIdentity": true,
"type": "integer"
},
"numericValue": {
"description": "A valid numeric response. If paired with a TextValue, the numeric equivalent of the TextValue.",
"format": "int",
"type": "integer"
},
"textValue": {
"description": "A valid text response. If paired with a NumericValue, the text equivalent of the NumericValue.",
"maxLength": 255,
"type": "string"
}
},
"required": [
"sortOrder"
],
"type": "object"
},
"edFi_surveyQuestionResponseSurveyQuestionMatrixElementResponse": {
"properties": {
"matrixElement": {
"description": "For matrix questions, the text identifying each row of the matrix.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 255,
"type": "string"
},
"maxNumericResponse": {
"description": "The maximum score possible on a survey.",
"format": "int",
"type": "integer"
},
"minNumericResponse": {
"description": "The minimum score possible on a survey.",
"format": "int",
"type": "integer"
},
"noResponse": {
"description": "Indicates there was no response to the question.",
"type": "boolean"
},
"numericResponse": {
"description": "The numeric response to the question.",
"format": "int",
"type": "integer"
},
"textResponse": {
"description": "The text response(s) for the question.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"matrixElement"
],
"type": "object"
},
"edFi_surveyQuestionResponseValue": {
"properties": {
"surveyQuestionResponseValueIdentifier": {
"description": "Primary key for the response value; a unique, usually sequential numeric value for a collection of responses, or potentially the value of NumericResponse for a single response.",
"format": "int",
"x-Ed-Fi-isIdentity": true,
"type": "integer"
},
"numericResponse": {
"description": "A numeric response to the question.",
"format": "int",
"type": "integer"
},
"textResponse": {
"description": "A text response to the question.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"surveyQuestionResponseValueIdentifier"
],
"type": "object"
},
"edFi_surveyReference": {
"properties": {
"namespace": {
"description": "Namespace for the Survey.",
"maxLength": 255,
"type": "string"
},
"surveyIdentifier": {
"description": "The unique survey identifier from the survey tool.",
"maxLength": 64,
"type": "string"
}
},
"required": [
"namespace",
"surveyIdentifier"
],
"type": "object"
},
"edFi_surveyResponse": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"surveyResponseIdentifier": {
"description": "The identifier of the survey typically from the survey application.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 64,
"type": "string"
},
"parentReference": {
"$ref": "#/definitions/edFi_parentReference"
},
"staffReference": {
"$ref": "#/definitions/edFi_staffReference"
},
"studentReference": {
"$ref": "#/definitions/edFi_studentReference"
},
"surveyReference": {
"$ref": "#/definitions/edFi_surveyReference"
},
"electronicMailAddress": {
"description": "Email address of the respondent.",
"maxLength": 128,
"type": "string"
},
"fullName": {
"description": "Full name of the respondent.",
"maxLength": 80,
"type": "string"
},
"location": {
"description": "Location of the respondent, often a city, district, or school.",
"maxLength": 75,
"type": "string"
},
"responseDate": {
"description": "Date of the survey response.",
"format": "date",
"type": "string"
},
"responseTime": {
"description": "The amount of time (in seconds) it took for the respondent to complete the survey.",
"format": "int",
"type": "integer"
},
"surveyLevels": {
"description": "An unordered collection of surveyResponseSurveyLevels. Provides information about the respondents of a survey and how they can be grouped together (ex., grade level, grade band, course type, etc.).",
"items": {
"$ref": "#/definitions/edFi_surveyResponseSurveyLevel"
},
"type": "array"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"surveyResponseIdentifier",
"id",
"responseDate",
"surveyReference"
],
"type": "object"
},
"edFi_surveyResponseEducationOrganizationTargetAssociation": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"educationOrganizationReference": {
"$ref": "#/definitions/edFi_educationOrganizationReference"
},
"surveyResponseReference": {
"$ref": "#/definitions/edFi_surveyResponseReference"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"educationOrganizationReference",
"surveyResponseReference"
],
"type": "object"
},
"edFi_surveyResponseReference": {
"properties": {
"namespace": {
"description": "Namespace for the Survey.",
"maxLength": 255,
"type": "string"
},
"surveyIdentifier": {
"description": "The unique survey identifier from the survey tool.",
"maxLength": 64,
"type": "string"
},
"surveyResponseIdentifier": {
"description": "The identifier of the survey typically from the survey application.",
"maxLength": 64,
"type": "string"
}
},
"required": [
"namespace",
"surveyIdentifier",
"surveyResponseIdentifier"
],
"type": "object"
},
"edFi_surveyResponseStaffTargetAssociation": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"staffReference": {
"$ref": "#/definitions/edFi_staffReference"
},
"surveyResponseReference": {
"$ref": "#/definitions/edFi_surveyResponseReference"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"staffReference",
"surveyResponseReference"
],
"type": "object"
},
"edFi_surveyResponseSurveyLevel": {
"properties": {
"surveyLevelDescriptor": {
"description": "Provides information about the respondents of a survey and how they can be grouped together (ex., grade level, grade band, course type, etc.).",
"x-Ed-Fi-isIdentity": true,
"maxLength": 306,
"type": "string"
}
},
"required": [
"surveyLevelDescriptor"
],
"type": "object"
},
"edFi_surveySection": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"surveySectionTitle": {
"description": "The title or label for the survey section.",
"x-Ed-Fi-isIdentity": true,
"maxLength": 255,
"type": "string"
},
"surveyReference": {
"$ref": "#/definitions/edFi_surveyReference"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"surveySectionTitle",
"id",
"surveyReference"
],
"type": "object"
},
"edFi_surveySectionAssociation": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"sectionReference": {
"$ref": "#/definitions/edFi_sectionReference"
},
"surveyReference": {
"$ref": "#/definitions/edFi_surveyReference"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"sectionReference",
"surveyReference"
],
"type": "object"
},
"edFi_surveySectionReference": {
"properties": {
"namespace": {
"description": "Namespace for the Survey.",
"maxLength": 255,
"type": "string"
},
"surveyIdentifier": {
"description": "The unique survey identifier from the survey tool.",
"maxLength": 64,
"type": "string"
},
"surveySectionTitle": {
"description": "The title or label for the survey section.",
"maxLength": 255,
"type": "string"
}
},
"required": [
"namespace",
"surveyIdentifier",
"surveySectionTitle"
],
"type": "object"
},
"edFi_surveySectionResponse": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"surveyResponseReference": {
"$ref": "#/definitions/edFi_surveyResponseReference"
},
"surveySectionReference": {
"$ref": "#/definitions/edFi_surveySectionReference"
},
"sectionRating": {
"description": "Numeric rating computed from the survey responses for the section.",
"format": "double",
"type": "number"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"surveyResponseReference",
"surveySectionReference"
],
"type": "object"
},
"edFi_surveySectionResponseEducationOrganizationTargetAssociation": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"educationOrganizationReference": {
"$ref": "#/definitions/edFi_educationOrganizationReference"
},
"surveySectionResponseReference": {
"$ref": "#/definitions/edFi_surveySectionResponseReference"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"educationOrganizationReference",
"surveySectionResponseReference"
],
"type": "object"
},
"edFi_surveySectionResponseReference": {
"properties": {
"namespace": {
"description": "Namespace for the Survey.",
"maxLength": 255,
"type": "string"
},
"surveyIdentifier": {
"description": "The unique survey identifier from the survey tool.",
"maxLength": 64,
"type": "string"
},
"surveyResponseIdentifier": {
"description": "The identifier of the survey typically from the survey application.",
"maxLength": 64,
"type": "string"
},
"surveySectionTitle": {
"description": "The title or label for the survey section.",
"maxLength": 255,
"type": "string"
}
},
"required": [
"namespace",
"surveyIdentifier",
"surveyResponseIdentifier",
"surveySectionTitle"
],
"type": "object"
},
"edFi_surveySectionResponseStaffTargetAssociation": {
"properties": {
"id": {
"description": "A resource identifier that uniquely identifies the resource.",
"type": "string"
},
"staffReference": {
"$ref": "#/definitions/edFi_staffReference"
},
"surveySectionResponseReference": {
"$ref": "#/definitions/edFi_surveySectionResponseReference"
},
"_etag": {
"description": "A unique system-generated value that identifies the version of the resource.",
"type": "string"
}
},
"required": [
"id",
"staffReference",
"surveySectionResponseReference"
],
"type": "object"
}
},
"info": {
"version": "rfc25",
"description": "The Survey API describes a REST API surface to enable exchange of survey metadata between disparate and geographically-separated systems operated by different organizations. The API resource models are derived from the Teacher Preparation Data Model and are consistent with the underling Ed-Fi Unifying Data Model v3.2.",
"title": "Ed-Fi Survey API"
},
"parameters": {
"offset": {
"description": "Indicates how many items should be skipped before returning results.",
"in": "query",
"name": "offset",
"required": false,
"default": 0,
"format": "int",
"type": "integer"
},
"limit": {
"description": "Indicates the maximum number of items that should be returned in the results.",
"in": "query",
"name": "limit",
"required": false,
"default": 25,
"format": "int",
"maxItems": 100,
"minItems": 1,
"type": "integer"
},
"MinChangeVersion": {
"description": "Used in synchronization to set sequence minimum ChangeVersion",
"in": "query",
"name": "minChangeVersion",
"required": false,
"format": "int",
"type": "integer"
},
"MaxChangeVersion": {
"description": "Used in synchronization to set sequence maximum ChangeVersion",
"in": "query",
"name": "maxChangeVersion",
"required": false,
"format": "int",
"type": "integer"
},
"If-None-Match": {
"description": "The previously returned ETag header value, used here to prevent the unnecessary data transfer of an unchanged resource.",
"in": "header",
"name": "If-None-Match",
"required": false,
"type": "string"
},
"fields": {
"description": "Specifies a subset of properties that should be returned for each entity (e.g. \"property1,collection1(collProp1,collProp2)\").",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
"queryExpression": {
"description": "Specifies a query filter expression for the request. Currently only supports range-based queries on dates and numbers (e.g. \"schoolId:[255901000...255901002]\" and \"BeginDate:[2016-03-07...2016-03-10]\").",
"in": "query",
"name": "q",
"required": false,
"type": "string"
}
},
"paths": {
"/ed-fi/surveys": {
"get": {
"deprecated": false,
"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": "getSurveys",
"parameters": [
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_survey"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveys"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurvey",
"parameters": [
{
"description": "The JSON representation of the \"survey\" resource to be created or updated.",
"in": "body",
"name": "survey",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_survey"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveys"
]
}
},
"/ed-fi/surveys/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveysById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_survey"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveys"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurvey",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"survey\" resource to be created or updated.",
"in": "body",
"name": "survey",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_survey"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveys"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveyById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveys"
]
}
},
"/ed-fi/surveyCourseAssociations": {
"get": {
"deprecated": false,
"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": "getSurveyCourseAssociations",
"parameters": [
{
"description": "A unique alphanumeric code assigned to a course.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "courseCode",
"required": false,
"maxLength": 60,
"type": "string"
},
{
"description": "The identifier assigned to an education organization.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "educationOrganizationId",
"required": false,
"format": "int",
"type": "integer"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveyCourseAssociation"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveyCourseAssociations"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveyCourseAssociation",
"parameters": [
{
"description": "The JSON representation of the \"surveyCourseAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveyCourseAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyCourseAssociation"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveyCourseAssociations"
]
}
},
"/ed-fi/surveyCourseAssociations/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveyCourseAssociationsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveyCourseAssociation"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveyCourseAssociations"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveyCourseAssociation",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveyCourseAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveyCourseAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyCourseAssociation"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveyCourseAssociations"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveyCourseAssociationById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveyCourseAssociations"
]
}
},
"/ed-fi/surveyProgramAssociations": {
"get": {
"deprecated": false,
"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": "getSurveyProgramAssociations",
"parameters": [
{
"description": "The identifier assigned to an education organization.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "educationOrganizationId",
"required": false,
"format": "int",
"type": "integer"
},
{
"description": "The formal name of the Program of instruction, training, services, or benefits available through federal, state, or local agencies.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "programName",
"required": false,
"maxLength": 60,
"type": "string"
},
{
"description": "The type of program.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "programTypeDescriptor",
"required": false,
"maxLength": 306,
"type": "string"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveyProgramAssociation"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveyProgramAssociations"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveyProgramAssociation",
"parameters": [
{
"description": "The JSON representation of the \"surveyProgramAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveyProgramAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyProgramAssociation"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveyProgramAssociations"
]
}
},
"/ed-fi/surveyProgramAssociations/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveyProgramAssociationsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveyProgramAssociation"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveyProgramAssociations"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveyProgramAssociation",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveyProgramAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveyProgramAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyProgramAssociation"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveyProgramAssociations"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveyProgramAssociationById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveyProgramAssociations"
]
}
},
"/ed-fi/surveyQuestions": {
"get": {
"deprecated": false,
"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": "getSurveyQuestions",
"parameters": [
{
"description": "The identifying code for the question, unique for the survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "questionCode",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveyQuestion"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveyQuestions"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveyQuestion",
"parameters": [
{
"description": "The JSON representation of the \"surveyQuestion\" resource to be created or updated.",
"in": "body",
"name": "surveyQuestion",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyQuestion"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveyQuestions"
]
}
},
"/ed-fi/surveyQuestions/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveyQuestionsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveyQuestion"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveyQuestions"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveyQuestion",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveyQuestion\" resource to be created or updated.",
"in": "body",
"name": "surveyQuestion",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyQuestion"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveyQuestions"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveyQuestionById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveyQuestions"
]
}
},
"/ed-fi/surveyQuestionResponses": {
"get": {
"deprecated": false,
"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": "getSurveyQuestionResponses",
"parameters": [
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The identifying code for the question, unique for the survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "questionCode",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The identifier of the survey typically from the survey application.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyResponseIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveyQuestionResponse"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveyQuestionResponses"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveyQuestionResponse",
"parameters": [
{
"description": "The JSON representation of the \"surveyQuestionResponse\" resource to be created or updated.",
"in": "body",
"name": "surveyQuestionResponse",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyQuestionResponse"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveyQuestionResponses"
]
}
},
"/ed-fi/surveyQuestionResponses/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveyQuestionResponsesById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveyQuestionResponse"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveyQuestionResponses"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveyQuestionResponse",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveyQuestionResponse\" resource to be created or updated.",
"in": "body",
"name": "surveyQuestionResponse",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyQuestionResponse"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveyQuestionResponses"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveyQuestionResponseById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveyQuestionResponses"
]
}
},
"/ed-fi/surveyResponses": {
"get": {
"deprecated": false,
"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": "getSurveyResponses",
"parameters": [
{
"description": "The identifier of the survey typically from the survey application.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyResponseIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveyResponse"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveyResponses"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveyResponse",
"parameters": [
{
"description": "The JSON representation of the \"surveyResponse\" resource to be created or updated.",
"in": "body",
"name": "surveyResponse",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyResponse"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveyResponses"
]
}
},
"/ed-fi/surveyResponses/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveyResponsesById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveyResponse"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveyResponses"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveyResponse",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveyResponse\" resource to be created or updated.",
"in": "body",
"name": "surveyResponse",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyResponse"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveyResponses"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveyResponseById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveyResponses"
]
}
},
"/ed-fi/surveyResponseEducationOrganizationTargetAssociations": {
"get": {
"deprecated": false,
"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": "getSurveyResponseEducationOrganizationTargetAssociations",
"parameters": [
{
"description": "The identifier assigned to an education organization.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "educationOrganizationId",
"required": false,
"format": "int",
"type": "integer"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The identifier of the survey typically from the survey application.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyResponseIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveyResponseEducationOrganizationTargetAssociation"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveyResponseEducationOrganizationTargetAssociations"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveyResponseEducationOrganizationTargetAssociation",
"parameters": [
{
"description": "The JSON representation of the \"surveyResponseEducationOrganizationTargetAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveyResponseEducationOrganizationTargetAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyResponseEducationOrganizationTargetAssociation"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveyResponseEducationOrganizationTargetAssociations"
]
}
},
"/ed-fi/surveyResponseEducationOrganizationTargetAssociations/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveyResponseEducationOrganizationTargetAssociationsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveyResponseEducationOrganizationTargetAssociation"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveyResponseEducationOrganizationTargetAssociations"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveyResponseEducationOrganizationTargetAssociation",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveyResponseEducationOrganizationTargetAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveyResponseEducationOrganizationTargetAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyResponseEducationOrganizationTargetAssociation"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveyResponseEducationOrganizationTargetAssociations"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveyResponseEducationOrganizationTargetAssociationById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveyResponseEducationOrganizationTargetAssociations"
]
}
},
"/ed-fi/surveyResponseStaffTargetAssociations": {
"get": {
"deprecated": false,
"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": "getSurveyResponseStaffTargetAssociations",
"parameters": [
{
"description": "A unique alphanumeric code assigned to a staff.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "staffUniqueId",
"required": false,
"maxLength": 32,
"type": "string"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The identifier of the survey typically from the survey application.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyResponseIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveyResponseStaffTargetAssociation"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveyResponseStaffTargetAssociations"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveyResponseStaffTargetAssociation",
"parameters": [
{
"description": "The JSON representation of the \"surveyResponseStaffTargetAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveyResponseStaffTargetAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyResponseStaffTargetAssociation"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveyResponseStaffTargetAssociations"
]
}
},
"/ed-fi/surveyResponseStaffTargetAssociations/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveyResponseStaffTargetAssociationsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveyResponseStaffTargetAssociation"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveyResponseStaffTargetAssociations"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveyResponseStaffTargetAssociation",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveyResponseStaffTargetAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveyResponseStaffTargetAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveyResponseStaffTargetAssociation"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveyResponseStaffTargetAssociations"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveyResponseStaffTargetAssociationById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveyResponseStaffTargetAssociations"
]
}
},
"/ed-fi/surveySections": {
"get": {
"deprecated": false,
"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": "getSurveySections",
"parameters": [
{
"description": "The title or label for the survey section.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveySectionTitle",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveySection"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveySections"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveySection",
"parameters": [
{
"description": "The JSON representation of the \"surveySection\" resource to be created or updated.",
"in": "body",
"name": "surveySection",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySection"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveySections"
]
}
},
"/ed-fi/surveySections/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveySectionsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveySection"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveySections"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveySection",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveySection\" resource to be created or updated.",
"in": "body",
"name": "surveySection",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySection"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveySections"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveySectionById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveySections"
]
}
},
"/ed-fi/surveySectionAssociations": {
"get": {
"deprecated": false,
"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": "getSurveySectionAssociations",
"parameters": [
{
"description": "The local code assigned by the School that identifies the course offering provided for the instruction of students.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "localCourseCode",
"required": false,
"maxLength": 60,
"type": "string"
},
{
"description": "The identifier assigned to a school.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "schoolId",
"required": false,
"format": "int",
"type": "integer"
},
{
"description": "The identifier for the school year.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "schoolYear",
"required": false,
"format": "int",
"type": "integer"
},
{
"description": "The local identifier assigned to a section.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "sectionIdentifier",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The identifier for the calendar for the academic session (e.g., 2010/11, 2011 Summer).",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "sessionName",
"required": false,
"maxLength": 60,
"type": "string"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveySectionAssociation"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveySectionAssociations"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveySectionAssociation",
"parameters": [
{
"description": "The JSON representation of the \"surveySectionAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveySectionAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySectionAssociation"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveySectionAssociations"
]
}
},
"/ed-fi/surveySectionAssociations/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveySectionAssociationsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveySectionAssociation"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveySectionAssociations"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveySectionAssociation",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveySectionAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveySectionAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySectionAssociation"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveySectionAssociations"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveySectionAssociationById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveySectionAssociations"
]
}
},
"/ed-fi/surveySectionResponses": {
"get": {
"deprecated": false,
"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": "getSurveySectionResponses",
"parameters": [
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The identifier of the survey typically from the survey application.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyResponseIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The title or label for the survey section.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveySectionTitle",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveySectionResponse"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveySectionResponses"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveySectionResponse",
"parameters": [
{
"description": "The JSON representation of the \"surveySectionResponse\" resource to be created or updated.",
"in": "body",
"name": "surveySectionResponse",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponse"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveySectionResponses"
]
}
},
"/ed-fi/surveySectionResponses/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveySectionResponsesById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponse"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveySectionResponses"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveySectionResponse",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveySectionResponse\" resource to be created or updated.",
"in": "body",
"name": "surveySectionResponse",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponse"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveySectionResponses"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveySectionResponseById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveySectionResponses"
]
}
},
"/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations": {
"get": {
"deprecated": false,
"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": "getSurveySectionResponseEducationOrganizationTargetAssociations",
"parameters": [
{
"description": "The identifier assigned to an education organization.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "educationOrganizationId",
"required": false,
"format": "int",
"type": "integer"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The identifier of the survey typically from the survey application.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyResponseIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The title or label for the survey section.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveySectionTitle",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveySectionResponseEducationOrganizationTargetAssociation"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveySectionResponseEducationOrganizationTargetAssociations"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveySectionResponseEducationOrganizationTargetAssociation",
"parameters": [
{
"description": "The JSON representation of the \"surveySectionResponseEducationOrganizationTargetAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveySectionResponseEducationOrganizationTargetAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponseEducationOrganizationTargetAssociation"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveySectionResponseEducationOrganizationTargetAssociations"
]
}
},
"/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponseEducationOrganizationTargetAssociation"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveySectionResponseEducationOrganizationTargetAssociations"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveySectionResponseEducationOrganizationTargetAssociation",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveySectionResponseEducationOrganizationTargetAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveySectionResponseEducationOrganizationTargetAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponseEducationOrganizationTargetAssociation"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveySectionResponseEducationOrganizationTargetAssociations"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveySectionResponseEducationOrganizationTargetAssociationById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveySectionResponseEducationOrganizationTargetAssociations"
]
}
},
"/ed-fi/surveySectionResponseStaffTargetAssociations": {
"get": {
"deprecated": false,
"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": "getSurveySectionResponseStaffTargetAssociations",
"parameters": [
{
"description": "A unique alphanumeric code assigned to a staff.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "staffUniqueId",
"required": false,
"maxLength": 32,
"type": "string"
},
{
"description": "Namespace for the Survey.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "namespace",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "The unique survey identifier from the survey tool.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The identifier of the survey typically from the survey application.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveyResponseIdentifier",
"required": false,
"maxLength": 64,
"type": "string"
},
{
"description": "The title or label for the survey section.",
"in": "query",
"x-Ed-Fi-isIdentity": true,
"name": "surveySectionTitle",
"required": false,
"maxLength": 255,
"type": "string"
},
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "query",
"name": "id",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"items": {
"$ref": "#/definitions/edFi_surveySectionResponseStaffTargetAssociation"
},
"type": "array"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"tags": [
"surveySectionResponseStaffTargetAssociations"
]
},
"post": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (you must use a PUT operation to update a resource by \"id\"). The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately.",
"operationId": "postSurveySectionResponseStaffTargetAssociation",
"parameters": [
{
"description": "The JSON representation of the \"surveySectionResponseStaffTargetAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveySectionResponseStaffTargetAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponseStaffTargetAssociation"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/Updated"
},
"201": {
"$ref": "#/responses/Created"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Creates or updates resources based on the natural key values of the supplied resource.",
"tags": [
"surveySectionResponseStaffTargetAssociations"
]
}
},
"/ed-fi/surveySectionResponseStaffTargetAssociations/{id}": {
"get": {
"deprecated": false,
"description": "This GET operation retrieves a resource by the specified resource identifier.",
"operationId": "getSurveySectionResponseStaffTargetAssociationsById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/If-None-Match"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The requested resource was successfully retrieved.",
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponseStaffTargetAssociation"
}
},
"304": {
"$ref": "#/responses/NotModified"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"tags": [
"surveySectionResponseStaffTargetAssociations"
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The PUT operation is used to update or create a resource by identifier. If the resource doesn't exist, the resource will be created using that identifier. Additionally, natural key values cannot be changed using this operation, and will not be modified in the database. If the resource \"id\" is provided in the JSON body, it will be ignored as well.",
"operationId": "putSurveySectionResponseStaffTargetAssociation",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
},
{
"description": "The JSON representation of the \"surveySectionResponseStaffTargetAssociation\" resource to be created or updated.",
"in": "body",
"name": "surveySectionResponseStaffTargetAssociation",
"required": true,
"schema": {
"$ref": "#/definitions/edFi_surveySectionResponseStaffTargetAssociation"
}
}
],
"responses": {
"204": {
"$ref": "#/responses/Updated"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Updates or creates a resource based on the resource identifier.",
"tags": [
"surveySectionResponseStaffTargetAssociations"
]
},
"delete": {
"consumes": [
"application/json"
],
"deprecated": false,
"description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId": "deleteSurveySectionResponseStaffTargetAssociationById",
"parameters": [
{
"description": "A resource identifier that uniquely identifies the resource.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"204": {
"$ref": "#/responses/Deleted"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"403": {
"$ref": "#/responses/Forbidden"
},
"404": {
"$ref": "#/responses/NotFound"
},
"409": {
"$ref": "#/responses/Conflict"
},
"412": {
"$ref": "#/responses/PreconditionFailed"
},
"500": {
"$ref": "#/responses/Error"
}
},
"summary": "Deletes an existing resource using the resource identifier.",
"tags": [
"surveySectionResponseStaffTargetAssociations"
]
}
}
},
"produces": [
"application/json"
],
"responses": {
"Created": {
"description": "The resource was created. An ETag value is available in the ETag header, and the location of the resource is available in the Location header of the response."
},
"Updated": {
"description": "The resource was updated. An updated ETag value is available in the ETag header of the response."
},
"Deleted": {
"description": "The resource was successfully deleted."
},
"NotModified": {
"description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified."
},
"BadRequest": {
"description": "Bad Request. The request was invalid and cannot be completed. See the response body for specific validation errors. This will typically be an issue with the query parameters or their values."
},
"Unauthorized": {
"description": "Unauthorized. The request requires authentication. The OAuth bearer token was either not provided or is invalid. The operation may succeed once authentication has been successfully completed."
},
"Forbidden": {
"description": "Forbidden. The request cannot be completed in the current authorization context. Contact your administrator if you believe this operation should be allowed."
},
"NotFound": {
"description": "The resource could not be found."
},
"Conflict": {
"description": "Conflict. The request cannot be completed because it would result in an invalid state. See the response body for details."
},
"PreconditionFailed": {
"description": "The resource's current server-side ETag value does not match the supplied If-Match header value in the request. This indicates the resource has been modified by another consumer."
},
"Error": {
"description": "An unhandled error occurred on the server. See the response body for details."
}
},
"security": [
{
"oauth2_client_credentials": []
}
],
"securityDefinitions": {
"oauth2_client_credentials": {
"description": "Ed-Fi ODS/API OAuth 2.0 Client Credentials Grant Type authorization",
"flow": "application",
"scopes": {},
"tokenUrl": "http://localhost:54746/oauth/token",
"type": "oauth2"
}
},
"tags": [
{
"description": "The course associated with the survey.",
"name": "surveyCourseAssociations"
},
{
"description": "The program associated with the survey.",
"name": "surveyProgramAssociations"
},
{
"description": "The response to a survey question.",
"name": "surveyQuestionResponses"
},
{
"description": "The questions for the survey.",
"name": "surveyQuestions"
},
{
"description": "This association provides information about the survey being taken and the education organization the survey is about.",
"name": "surveyResponseEducationOrganizationTargetAssociations"
},
{
"description": "Responses to a Survey for named or anonymous persons.",
"name": "surveyResponses"
},
{
"description": "The association provides information about the survey being taken and who the survey is about.",
"name": "surveyResponseStaffTargetAssociations"
},
{
"description": "A survey to identified or anonymous respondants.",
"name": "surveys"
},
{
"description": "The section associated with the survey.",
"name": "surveySectionAssociations"
},
{
"description": "This association provides information about the survey section and the Education Organization the survey section is about.",
"name": "surveySectionResponseEducationOrganizationTargetAssociations"
},
{
"description": "Optional information about the responses provided for a section of a survey.",
"name": "surveySectionResponses"
},
{
"description": "This association provides information about the survey section and the staff the survey section is about.",
"name": "surveySectionResponseStaffTargetAssociations"
},
{
"description": "The section(s) of questions for the survey.",
"name": "surveySections"
}
]
}