...
The GET, POST, and PUT columns indicate if the attribute is required ("yes"), optional ("opt"), or must not have ("no")k.
Attribute |
|
|
| Notes |
|---|---|---|---|---|
| yes | yes | yes | |
| yes | yes | yes | Value preferred to be one or more words rather than a numeric code or random string. |
| yes | yes | yes | |
| yes* | opt | opt | Longer description that may contain additional normative usage guidance. |
| yes* | opt | opt | Date for display only, not validation |
| yes* | opt | opt | Date for display only, not validation |
| yes | no | yes | |
| opt | no | no | Required when the host implements etags. |
| opt | no | no | Retained only for backward-compliance with existing ODS/API implementations. |
| opt | no | no | Retained only for backward-compliance with existing ODS/API implementations. |
| opt | no | no | Date for display only, not validation |
* if a value was provided in POST / PUT
URL Construction and HTTP Verb Usage for Ed-Fi Descriptors
...
Table 4. Accessing and Manipulating Descriptors
Resource | POST | GET | PUT | DELETE |
|---|---|---|---|---|
| Adds a new Descriptor | Gets all Descriptors for the subtype | Error | Error |
| Error | Gets all attributes for an individual Descriptor | Updates an individual Descriptor | Deletes an individual Descriptor |
Descriptor References
Many Ed-Fi Resources have one or more Descriptor in their lists of attributes. The Descriptor value is a Uniform Resource Indicator (URI). The URI for a Descriptor must be constructed in the following format:
...
For example, to refer to the academicSubject value in the Ed-Fi namespace ("http://ed-fi.org") with a codeValue of "Chemistry" the reference would be the following URI:
...
An Ed-Fi API should expose all Descriptors via a REST interface, using the standard REST API conventionsConventions. However, it is recommended that access to the HTTP verbs be carefully controlled:
...