Ed-Fi RFC 18 - OpenAPI Spec
Eric Jansson
Owned by Eric Jansson
Jun 28, 2019
181 min read
Loading data...
This page contains the full OpenAPI spec listing for the proposed ED-FI RFC 18 - Finance API.
Change History
- March 18, 2019: Initial Draft (Ed-Fi-Finance-API-v.rfc18.json).
 API Specification
{
"swagger" : "2.0",
"info" : {
"description" : "The Finance API describes an API surface useful for the exchange of education organization finance data. Specifically, the proposed data model is designed to accommodate the federally mandated Every Student Succeeds Act (ESSA) financial transparency reporting.",
"version" : "rfc18",
"title" : "Ed-Fi Finance API - RFC 18"
},
"basePath" : "/",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"tags" : [ {
"name" : "balanceSheetDimensions",
"description" : "The NCES balance sheet accounting dimension. The NCES definition states that the balance sheet accounts and statement of net position accounts are used to track financial transactions for each fund. Such financial statements only report assets, deferred outflows of resources, liabilities, deferred inflows of resources, and equity accounts. The statements are considered \"snapshots\" of how these accounts stand as of a certain point in time."
}, {
"name" : "chartOfAccounts",
"description" : "A valid combination of account dimensions under which financials are reported. This financial entity represents a funding source combined with its purpose and type of transaction. It provides a formal record of the debits and credits relating to the specific account."
}, {
"name" : "functionDimensions",
"description" : "The NCES function accounting dimension representing an expenditure. Per the NCES definition, the function describes the activity for which a service or material object is acquired. The functions of a school district are generally classified into five broad areas, including instruction, support services, operation of non-instructional services, facilities acquisition and construction, and debt service. Functions are typically further classified into sub-functions. Most SEAs use a similar definition."
}, {
"name" : "fundDimensions",
"description" : "The NCES fund accounting dimension. A fund is defined by the NCES as \"a fiscal and accounting entity with a self-balancing set of accounts recording cash and other financial resources, together with all related liabilities and residual equities or balances, and changes therein, which are segregated for the purpose of carrying on specific activities or attaining certain objectives in accordance with special regulations, restrictions, or limitations.\" Most SEAs use a similar definition."
}, {
"name" : "localAccounts",
"description" : "The set of account codes defined by an education organization for a fiscal year. It provides a formal record of the debits and credits relating to the specific account."
}, {
"name" : "localActuals",
"description" : "The set of local education agency or charter management organization actual financial result amounts, typically based on the accrual basis of accounting."
}, {
"name" : "localBudgets",
"description" : "The set of local education agency or charter management organization budget amounts."
}, {
"name" : "objectDimensions",
"description" : "The NCES object accounting dimension representing an expenditure. Per the NCES definition, this classification is used to describe the service or commodity obtained as the result of a specific expenditure, such as salaries, benefits, tuition reimbursement, and so forth. Most SEAs use a similar definition."
}, {
"name" : "operationalUnitDimensions",
"description" : "The NCES operational unit accounting dimension. Per the NCES, this dimension is used to segregate costs by school and operational unit such as physical location, department, or other method. SEAs may provide guidance to LEAS on how to structure this code, or it may be at the discretion of the local organizations."
}, {
"name" : "programDimensions",
"description" : "The NCES program accounting dimension. A program is defined by the NCES as \"a plan of activities and procedures designed to accomplish a predetermined objective or set of objectives.\" These are often categorized into broad program areas such as regular education, special education, vocational education, other PK-12 instructional, nonpublic school, adult and continuing education, community and junior college education, community services, and co-curricular or extracurricular activities. Most SEAs use a similar definition."
}, {
"name" : "projectDimensions",
"description" : "The NCES project accounting dimension. Per the NCES, the project dimension reporting code permits school districts to accumulate expenditures to meet a variety of specialized reporting requirements at the local, state, and federal levels. In the NCES reporting scheme, this is typically a three-digit code with the format 00X. The first two digits identify the particular funding source, authority, or expenditure purpose for which a special record or report is required. The third digit is available to identify particular projects and the fiscal year of the appropriation within that funding source. SEAs will typically provide guidance to LEAs on how to structure this code."
}, {
"name" : "sourceDimensions",
"description" : "The NCES source dimension. Per the NCES, the source dimension is used to classify revenue, receivables, and other sources of income based on their origins such as taxes, tuition, fees, and so forth. Revenue increases both the assets and the equity of a local education agency or charter management organization as a whole. Most SEAs use a similar definition."
} ],
"paths" : {
"/ed-fi-xfinance/balanceSheetDimensions" : {
"get" : {
"tags" : [ "balanceSheetDimensions" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getBalanceSheetDimensions",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "code",
"in" : "query",
"description" : "The code representation of the account Balance Sheet dimension.",
"required" : false,
"type" : "string",
"maxLength" : 16,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "The fiscal year for which the account Balance Sheet dimension is valid.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_balanceSheetDimension"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "balanceSheetDimensions" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postBalanceSheetDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "balanceSheetDimension",
"in" : "body",
"description" : "The JSON representation of the \"balanceSheetDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_balanceSheetDimension"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/balanceSheetDimensions/{id}" : {
"get" : {
"tags" : [ "balanceSheetDimensions" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getBalanceSheetDimensionsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_balanceSheetDimension"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "balanceSheetDimensions" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putBalanceSheetDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "balanceSheetDimension",
"in" : "body",
"description" : "The JSON representation of the \"balanceSheetDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_balanceSheetDimension"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "balanceSheetDimensions" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteBalanceSheetDimensionById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/chartOfAccounts" : {
"get" : {
"tags" : [ "chartOfAccounts" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getChartOfAccounts",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "accountIdentifier",
"in" : "query",
"description" : "SEA populated Code value for the valid combination of account dimensions under which financials are reported.",
"required" : false,
"type" : "string",
"maxLength" : 50,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "Fiscal year for the account",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "educationOrganizationId",
"in" : "query",
"description" : "The identifier assigned to an education organization.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"items" : {
"$ref" : "#/definitions/edFiXFinance_chartOfAccount"
},
"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"
}
}
},
"post" : {
"tags" : [ "chartOfAccounts" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postChartOfAccount",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "chartOfAccount",
"in" : "body",
"description" : "The JSON representation of the \"chartOfAccount\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_chartOfAccount"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/chartOfAccounts/{id}" : {
"get" : {
"tags" : [ "chartOfAccounts" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getChartOfAccountsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_chartOfAccount"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "chartOfAccounts" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putChartOfAccount",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "chartOfAccount",
"in" : "body",
"description" : "The JSON representation of the \"chartOfAccount\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_chartOfAccount"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "chartOfAccounts" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteChartOfAccountById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/functionDimensions" : {
"get" : {
"tags" : [ "functionDimensions" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getFunctionDimensions",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "code",
"in" : "query",
"description" : "The code representation of the account Function dimension.",
"required" : false,
"type" : "string",
"maxLength" : 16,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "The fiscal year for which the account Function dimension is valid.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_functionDimension"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "functionDimensions" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postFunctionDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "functionDimension",
"in" : "body",
"description" : "The JSON representation of the \"functionDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_functionDimension"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/functionDimensions/{id}" : {
"get" : {
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getFunctionDimensionsById",
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_functionDimension"
}
},
"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" : [ "functionDimensions" ]
},
"put" : {
"consumes" : [ "application/json" ],
"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" : "putFunctionDimension",
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"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 \"functionDimension\" resource to be created or updated.",
"in" : "body",
"name" : "functionDimension",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_functionDimension"
}
} ],
"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" : [ "functionDimensions" ]
},
"delete" : {
"tags" : [ "functionDimensions" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteFunctionDimensionById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/fundDimensions" : {
"get" : {
"tags" : [ "fundDimensions" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getFundDimensions",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "code",
"in" : "query",
"description" : "The code representation of the account Fund dimension.",
"required" : false,
"type" : "string",
"maxLength" : 16,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "The fiscal year for which the account Fund dimension is valid.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_fundDimension"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "fundDimensions" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postFundDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "fundDimension",
"in" : "body",
"description" : "The JSON representation of the \"fundDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_fundDimension"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/fundDimensions/{id}" : {
"get" : {
"tags" : [ "fundDimensions" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getFundDimensionsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_fundDimension"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "fundDimensions" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putFundDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "fundDimension",
"in" : "body",
"description" : "The JSON representation of the \"fundDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_fundDimension"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "fundDimensions" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteFundDimensionById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/localAccounts" : {
"get" : {
"tags" : [ "localAccounts" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getLocalAccounts",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "accountIdentifier",
"in" : "query",
"description" : "Code value for the valid combination of account dimensions by LEA under which financials are reported.",
"required" : false,
"type" : "string",
"maxLength" : 50,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "Fiscal year for the account",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "educationOrganizationId",
"in" : "query",
"description" : "The identifier assigned to an education organization.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"description" : "A descriptive name for the account",
"in" : "query",
"name" : "accountName",
"required" : false,
"maxLength" : 100,
"type" : "string"
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_localAccount"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "localAccounts" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postLocalAccount",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "localAccount",
"in" : "body",
"description" : "The JSON representation of the \"localAccount\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localAccount"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/localAccounts/{id}" : {
"get" : {
"tags" : [ "localAccounts" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getLocalAccountsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localAccount"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "localAccounts" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putLocalAccount",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "localAccount",
"in" : "body",
"description" : "The JSON representation of the \"localAccount\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localAccount"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "localAccounts" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteLocalAccountById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/localActuals" : {
"get" : {
"tags" : [ "localActuals" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getLocalActuals",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "asOfDate",
"in" : "query",
"description" : "The date of the reported amount for Account.",
"required" : false,
"type" : "string",
"format" : "date",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "accountIdentifier",
"in" : "query",
"description" : "Code value for the valid combination of account dimensions by LEA under which financials are reported.",
"required" : false,
"type" : "string",
"maxLength" : 50,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "educationOrganizationId",
"in" : "query",
"description" : "The identifier assigned to an education organization.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "Fiscal year for the account",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_localActual"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "localActuals" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postLocalActual",
"consumes" : [ "application/json" ],
"parameters" : [ {
"description" : "The JSON representation of the \"localActual\" resource to be created or updated.",
"in" : "body",
"name" : "localActual",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localActual"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/localActuals/{id}" : {
"get" : {
"tags" : [ "localActuals" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getLocalActualsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localActual"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "localActuals" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putLocalActual",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "localActual",
"in" : "body",
"description" : "The JSON representation of the \"localActual\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localActual"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "localActuals" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteLocalActualById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/localBudgets" : {
"get" : {
"tags" : [ "localBudgets" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getLocalBudgets",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "asOfDate",
"in" : "query",
"description" : "The date that the amount is applied to.",
"required" : false,
"type" : "string",
"format" : "date",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "accountIdentifier",
"in" : "query",
"description" : "Code value for the valid combination of account dimensions by LEA under which financials are reported.",
"required" : false,
"type" : "string",
"maxLength" : 50,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "educationOrganizationId",
"in" : "query",
"description" : "The identifier assigned to an education organization.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "Fiscal year for the account",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_localBudget"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "localBudgets" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postLocalBudget",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "localBudget",
"in" : "body",
"description" : "The JSON representation of the \"localBudget\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localBudget"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/localBudgets/{id}" : {
"get" : {
"tags" : [ "localBudgets" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getLocalBudgetsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localBudget"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "localBudgets" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putLocalBudget",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "localBudget",
"in" : "body",
"description" : "The JSON representation of the \"localBudget\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_localBudget"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "localBudgets" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteLocalBudgetById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/objectDimensions" : {
"get" : {
"tags" : [ "objectDimensions" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getObjectDimensions",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "code",
"in" : "query",
"description" : "The code representation of the account Object dimension.",
"required" : false,
"type" : "string",
"maxLength" : 16,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "The fiscal year for which the account Object dimension is valid.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_objectDimension"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "objectDimensions" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"consumes" : [ "application/json" ],
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to 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" : "postObjectDimension",
"parameters" : [ {
"name" : "objectDimension",
"in" : "body",
"description" : "The JSON representation of the \"objectDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_objectDimension"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/objectDimensions/{id}" : {
"get" : {
"tags" : [ "objectDimensions" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getObjectDimensionsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_objectDimension"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "objectDimensions" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putObjectDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "objectDimension",
"in" : "body",
"description" : "The JSON representation of the \"objectDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_objectDimension"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "objectDimensions" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteObjectDimensionById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/operationalUnitDimensions" : {
"get" : {
"tags" : [ "operationalUnitDimensions" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getOperationalUnitDimensions",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "code",
"in" : "query",
"description" : "The code representation of the account Operational Unit dimension.",
"required" : false,
"type" : "string",
"maxLength" : 16,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "The fiscal year for which the account Operational Unit dimension is valid.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_operationalUnitDimension"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "operationalUnitDimensions" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postOperationalUnitDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "operationalUnitDimension",
"in" : "body",
"description" : "The JSON representation of the \"operationalUnitDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_operationalUnitDimension"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/operationalUnitDimensions/{id}" : {
"get" : {
"tags" : [ "operationalUnitDimensions" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getOperationalUnitDimensionsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_operationalUnitDimension"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "operationalUnitDimensions" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putOperationalUnitDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "operationalUnitDimension",
"in" : "body",
"description" : "The JSON representation of the \"operationalUnitDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_operationalUnitDimension"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "operationalUnitDimensions" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteOperationalUnitDimensionById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/programDimensions" : {
"get" : {
"tags" : [ "programDimensions" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getProgramDimensions",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "code",
"in" : "query",
"description" : "The code representation of the account Program dimension.",
"required" : false,
"type" : "string",
"maxLength" : 16,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "The fiscal year for which the account Program dimension is valid.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_programDimension"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "programDimensions" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postProgramDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "programDimension",
"in" : "body",
"description" : "The JSON representation of the \"programDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_programDimension"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/programDimensions/{id}" : {
"get" : {
"tags" : [ "programDimensions" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getProgramDimensionsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_programDimension"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "programDimensions" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putProgramDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "programDimension",
"in" : "body",
"description" : "The JSON representation of the \"programDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_programDimension"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "programDimensions" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteProgramDimensionById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/projectDimensions" : {
"get" : {
"tags" : [ "projectDimensions" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getProjectDimensions",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "code",
"in" : "query",
"description" : "The code representation of the account Project dimension.",
"required" : false,
"type" : "string",
"maxLength" : 16,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "The fiscal year for which the account Project dimension is valid.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_projectDimension"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "projectDimensions" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postProjectDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "projectDimension",
"in" : "body",
"description" : "The JSON representation of the \"projectDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_projectDimension"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/projectDimensions/{id}" : {
"get" : {
"tags" : [ "projectDimensions" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getProjectDimensionsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_projectDimension"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "projectDimensions" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putProjectDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "projectDimension",
"in" : "body",
"description" : "The JSON representation of the \"projectDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_projectDimension"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "projectDimensions" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteProjectDimensionById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
},
"/ed-fi-xfinance/sourceDimensions" : {
"get" : {
"tags" : [ "sourceDimensions" ],
"summary" : "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).",
"description" : "This GET operation provides access to resources using the \"Get\" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).",
"operationId" : "getSourceDimensions",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/offset"
}, {
"$ref" : "#/parameters/limit"
}, {
"name" : "code",
"in" : "query",
"description" : "The code representation of the account Source dimension.",
"required" : false,
"type" : "string",
"maxLength" : 16,
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "fiscalYear",
"in" : "query",
"description" : "The fiscal year for which the account Source dimension is valid.",
"required" : false,
"type" : "integer",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true
}, {
"name" : "id",
"in" : "query",
"description" : "A resource identifier that uniquely identifies the resource.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/edFiXFinance_sourceDimension"
}
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"post" : {
"tags" : [ "sourceDimensions" ],
"summary" : "Creates or updates resources based on the natural key values of the supplied resource.",
"description" : "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error (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" : "postSourceDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"description" : "The JSON representation of the \"sourceDimension\" resource to be created or updated.",
"in" : "body",
"name" : "sourceDimension",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_sourceDimension"
}
} ],
"responses" : {
"201" : {
"$ref" : "#/responses/Created"
},
"204" : {
"$ref" : "#/responses/Updated"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"409" : {
"$ref" : "#/responses/Conflict"
},
"412" : {
"$ref" : "#/responses/PreconditionFailed"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
}
},
"/ed-fi-xfinance/sourceDimensions/{id}" : {
"get" : {
"tags" : [ "sourceDimensions" ],
"summary" : "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).",
"description" : "This GET operation retrieves a resource by the specified resource identifier.",
"operationId" : "getSourceDimensionsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"$ref" : "#/parameters/If-None-Match"
} ],
"responses" : {
"200" : {
"description" : "The requested resource was successfully retrieved.",
"schema" : {
"$ref" : "#/definitions/edFiXFinance_sourceDimension"
}
},
"304" : {
"$ref" : "#/responses/NotModified"
},
"400" : {
"$ref" : "#/responses/BadRequest"
},
"401" : {
"$ref" : "#/responses/Unauthorized"
},
"403" : {
"$ref" : "#/responses/Forbidden"
},
"404" : {
"$ref" : "#/responses/NotFound"
},
"500" : {
"$ref" : "#/responses/Error"
}
}
},
"put" : {
"tags" : [ "sourceDimensions" ],
"summary" : "Updates or creates a resource based on the resource identifier.",
"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" : "putSourceDimension",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the PUT from updating a resource modified by another consumer.",
"type" : "string"
}, {
"name" : "sourceDimension",
"in" : "body",
"description" : "The JSON representation of the \"sourceDimension\" resource to be created or updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edFiXFinance_sourceDimension"
}
} ],
"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"
}
}
},
"delete" : {
"tags" : [ "sourceDimensions" ],
"summary" : "Deletes an existing resource using the resource identifier.",
"description" : "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).",
"operationId" : "deleteSourceDimensionById",
"consumes" : [ "application/json" ],
"parameters" : [ {
"$ref" : "#/parameters/id"
}, {
"name" : "If-Match",
"in" : "header",
"description" : "The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.",
"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"
}
}
}
}
},
"definitions" : {
"edFiXFinance_balanceSheetDimension" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"code" : {
"description" : "The code representation of the account Balance Sheet dimension.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Balance Sheet dimension is valid.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"codeName" : {
"description" : "A description of the account Balance Sheet dimension.",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of balanceSheetDimensionReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_balanceSheetDimensionReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "code", "fiscalYear", "id" ],
"type" : "object"
},
"edFiXFinance_balanceSheetDimensionReference" : {
"properties" : {
"code" : {
"description" : "The code representation of the account Balance Sheet dimension.",
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Balance Sheet dimension is valid.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "code", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_balanceSheetDimensionReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "Optional tag for accountability reporting (e.g. ESSA).",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_chartOfAccount" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"accountIdentifier" : {
"description" : "SEA populated Code value for the valid combination of account dimensions under which financials are reported.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 50,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account applies.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"balanceSheetDimensionReference" : {
"$ref" : "#/definitions/edFiXFinance_balanceSheetDimensionReference"
},
"educationOrganizationReference" : {
"$ref" : "#/definitions/edFi_educationOrganizationReference"
},
"functionDimensionReference" : {
"$ref" : "#/definitions/edFiXFinance_functionDimensionReference"
},
"fundDimensionReference" : {
"$ref" : "#/definitions/edFiXFinance_fundDimensionReference"
},
"objectDimensionReference" : {
"$ref" : "#/definitions/edFiXFinance_objectDimensionReference"
},
"operationalUnitDimensionReference" : {
"$ref" : "#/definitions/edFiXFinance_operationalUnitDimensionReference"
},
"programDimensionReference" : {
"$ref" : "#/definitions/edFiXFinance_programDimensionReference"
},
"projectDimensionReference" : {
"$ref" : "#/definitions/edFiXFinance_projectDimensionReference"
},
"sourceDimensionReference" : {
"$ref" : "#/definitions/edFiXFinance_sourceDimensionReference"
},
"accountName" : {
"description" : "A descriptive name for the account",
"maxLength" : 100,
"type" : "string"
},
"accountTypeDescriptor" : {
"description" : "Type of Account such as Revenue, Expenditure, or Balance Sheet.",
"maxLength" : 306,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of chartOfAccountReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_chartOfAccountReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "accountIdentifier", "fiscalYear", "accountTypeDescriptor", "id", "educationOrganizationReference" ],
"type" : "object"
},
"edFiXFinance_chartOfAccountReference" : {
"properties" : {
"accountIdentifier" : {
"description" : "SEA populated Code value for the valid combination of account dimensions under which financials are reported.",
"maxLength" : 50,
"type" : "string"
},
"educationOrganizationId" : {
"description" : "The identifier assigned to an education organization.",
"format" : "int32",
"type" : "integer"
},
"fiscalYear" : {
"description" : "Fiscal year for the account",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "accountIdentifier", "educationOrganizationId", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_chartOfAccountReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "ReportingTag Descriptor",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
},
"tagValue" : {
"description" : "TagValue",
"maxLength" : 100,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_functionDimension" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"code" : {
"description" : "The code representation of the account Function dimension.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Function dimension is valid.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"codeName" : {
"description" : "A description of the account Function dimension.",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of functionDimensionReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_functionDimensionReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "code", "fiscalYear", "id" ],
"type" : "object"
},
"edFiXFinance_functionDimensionReference" : {
"properties" : {
"code" : {
"description" : "The code representation of the account Function dimension.",
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Function dimension is valid.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "code", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_functionDimensionReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "Optional tag for accountability reporting (e.g. ESSA).",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_fundDimension" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"code" : {
"description" : "The code representation of the account Fund dimension.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Fund dimension is valid.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"codeName" : {
"description" : "A description of the account Fund dimension.",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of fundDimensionReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_fundDimensionReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "code", "fiscalYear", "id" ],
"type" : "object"
},
"edFiXFinance_fundDimensionReference" : {
"properties" : {
"code" : {
"description" : "The code representation of the account Fund dimension.",
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Fund dimension is valid.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "code", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_fundDimensionReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "Optional tag for accountability reporting (e.g. ESSA).",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_localAccount" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"accountIdentifier" : {
"description" : "Code value for the valid combination of account dimensions by LEA under which financials are reported.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 50,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account applies.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"chartOfAccountReference" : {
"$ref" : "#/definitions/edFiXFinance_chartOfAccountReference"
},
"educationOrganizationReference" : {
"$ref" : "#/definitions/edFi_educationOrganizationReference"
},
"accountName" : {
"description" : "A descriptive name for the account",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of localAccountReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_localAccountReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "accountIdentifier", "fiscalYear", "id", "chartOfAccountReference", "educationOrganizationReference" ],
"type" : "object"
},
"edFiXFinance_localAccountReference" : {
"properties" : {
"accountIdentifier" : {
"description" : "Code value for the valid combination of account dimensions by LEA under which financials are reported.",
"maxLength" : 50,
"type" : "string"
},
"educationOrganizationId" : {
"description" : "The identifier assigned to an education organization.",
"format" : "int32",
"type" : "integer"
},
"fiscalYear" : {
"description" : "Fiscal year for the account",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "accountIdentifier", "educationOrganizationId", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_localAccountReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "ReportinTag Descriptor",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
},
"tagValue" : {
"description" : "TagValue",
"maxLength" : 100,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_localActual" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"asOfDate" : {
"description" : "The date of the reported amount for Account.",
"format" : "date",
"x-Ed-Fi-isIdentity" : true,
"type" : "string"
},
"localAccountReference" : {
"$ref" : "#/definitions/edFiXFinance_localAccountReference"
},
"amount" : {
"description" : "Current balance for the account.",
"format" : "double",
"type" : "number"
},
"financialCollectionDescriptor" : {
"description" : "The accounting period or grouping for which the amount is collected.",
"maxLength" : 306,
"type" : "string"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "asOfDate", "amount", "id", "localAccountReference" ],
"type" : "object"
},
"edFiXFinance_localBudget" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"asOfDate" : {
"description" : "The date that the amount is applied to.",
"format" : "date",
"x-Ed-Fi-isIdentity" : true,
"type" : "string"
},
"localAccountReference" : {
"$ref" : "#/definitions/edFiXFinance_localAccountReference"
},
"amount" : {
"description" : "Currency value applied to the account.",
"format" : "double",
"type" : "number"
},
"financialCollectionDescriptor" : {
"description" : "The accounting period or grouping for which the amount is collected.",
"maxLength" : 306,
"type" : "string"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "asOfDate", "amount", "id", "localAccountReference" ],
"type" : "object"
},
"edFiXFinance_objectDimension" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"code" : {
"description" : "The code representation of the account Object dimension.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Object dimension is valid.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"codeName" : {
"description" : "A description of the account Object dimension.",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of objectDimensionReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_objectDimensionReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "code", "fiscalYear", "id" ],
"type" : "object"
},
"edFiXFinance_objectDimensionReference" : {
"properties" : {
"code" : {
"description" : "The code representation of the account Object dimension.",
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Object dimension is valid.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "code", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_objectDimensionReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "Optional tag for accountability reporting (e.g. ESSA).",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_operationalUnitDimension" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"code" : {
"description" : "The code representation of the account Operational Unit dimension.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Operational Unit dimension is valid.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"codeName" : {
"description" : "A description of the account Operational Unit dimension.",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of operationalUnitDimensionReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_operationalUnitDimensionReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "code", "fiscalYear", "id" ],
"type" : "object"
},
"edFiXFinance_operationalUnitDimensionReference" : {
"properties" : {
"code" : {
"description" : "The code representation of the account Operational Unit dimension.",
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Operational Unit dimension is valid.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "code", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_operationalUnitDimensionReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "Optional tag for accountability reporting (e.g. ESSA).",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_programDimension" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"code" : {
"description" : "The code representation of the account Program dimension.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Program dimension is valid.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"codeName" : {
"description" : "A description of the account Program dimension.",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of programDimensionReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_programDimensionReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "code", "fiscalYear", "id" ],
"type" : "object"
},
"edFiXFinance_programDimensionReference" : {
"properties" : {
"code" : {
"description" : "The code representation of the account Program dimension.",
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Program dimension is valid.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "code", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_programDimensionReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "Optional tag for accountability reporting (e.g., ESSA).",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_projectDimension" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"code" : {
"description" : "The code representation of the account Project dimension.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Project dimension is valid.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"codeName" : {
"description" : "A description of the account Project dimension.",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of projectDimensionReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_projectDimensionReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "code", "fiscalYear", "id" ],
"type" : "object"
},
"edFiXFinance_projectDimensionReference" : {
"properties" : {
"code" : {
"description" : "The code representation of the account Project dimension.",
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Project dimension is valid.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "code", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_projectDimensionReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "Optional tag for accountability reporting (e.g. ESSA).",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFiXFinance_sourceDimension" : {
"properties" : {
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"type" : "string"
},
"code" : {
"description" : "The code representation of the account Source dimension.",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Source dimension is valid.",
"format" : "int32",
"x-Ed-Fi-isIdentity" : true,
"type" : "integer"
},
"codeName" : {
"description" : "A description of the account Source dimension.",
"maxLength" : 100,
"type" : "string"
},
"reportingTags" : {
"description" : "An unordered collection of sourceDimensionReportingTags. Optional tag for accountability reporting (e.g. ESSA).",
"items" : {
"$ref" : "#/definitions/edFiXFinance_sourceDimensionReportingTag"
},
"type" : "array"
},
"_etag" : {
"description" : "A unique system-generated value that identifies the version of the resource.",
"type" : "string"
}
},
"required" : [ "code", "fiscalYear", "id" ],
"type" : "object"
},
"edFiXFinance_sourceDimensionReference" : {
"properties" : {
"code" : {
"description" : "The code representation of the account Source dimension.",
"maxLength" : 16,
"type" : "string"
},
"fiscalYear" : {
"description" : "The fiscal year for which the account Source dimension is valid.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "code", "fiscalYear" ],
"type" : "object"
},
"edFiXFinance_sourceDimensionReportingTag" : {
"properties" : {
"reportingTagDescriptor" : {
"description" : "Optional tag for accountability reporting (e.g. ESSA).",
"x-Ed-Fi-isIdentity" : true,
"maxLength" : 306,
"type" : "string"
}
},
"required" : [ "reportingTagDescriptor" ],
"type" : "object"
},
"edFi_educationOrganizationReference" : {
"properties" : {
"educationOrganizationId" : {
"description" : "The identifier assigned to an education organization.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [ "educationOrganizationId" ],
"type" : "object"
}
},
"parameters" : {
"offset" : {
"description" : "Indicates how many items should be skipped before returning results.",
"in" : "query",
"name" : "offset",
"required" : false,
"default" : 0,
"format" : "int32",
"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" : "int32",
"maxItems" : 100,
"minItems" : 1,
"type" : "integer"
},
"MinChangeVersion" : {
"description" : "Used in synchronization to set sequence minimum ChangeVersion",
"in" : "query",
"name" : "minChangeVersion",
"required" : false,
"format" : "int32",
"type" : "integer"
},
"MaxChangeVersion" : {
"description" : "Used in synchronization to set sequence maximum ChangeVersion",
"in" : "query",
"name" : "maxChangeVersion",
"required" : false,
"format" : "int32",
"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"
},
"id" : {
"description" : "A resource identifier that uniquely identifies the resource.",
"in" : "path",
"name" : "id",
"required" : true,
"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. \"[2016-03-07..2016-03-10]\").",
"in" : "query",
"name" : "q",
"required" : false,
"type" : "string"
}
},
"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."
}
}
}