ETags and Other REST API Conventions and Features
ETags (Entity Tags)[9] are mechanisms used to support optimistic concurrency and efficient bandwidth handling. The use of ETags is recommended for Ed-Fi REST API implementations.
Other REST API Conventions and Features
Three additional REST API features—case sensitivity, encryption, and version—are discussed in the following table.
Table 7. Additional REST API Features
| REST Feature | Ed-Fi Implementation | Explanation |
|---|---|---|
Case Sensitivity | /users?firstName=JOHN /users?FIRSTNAME=John | URIs, parameter names, and parameter values must not be case sensitive. The two URI’s to the left will produce the same results. |
Encryption | HTTPS | All calls to the API must use SSL. |
Version | https://api.example.com/v1/users or … https://example.com/api/v1/users | The version number should be specified in the base URI. |
9 For more information on ETags, see here and IETF RFC 7232, Section 2.3 here.
, multiple selections available,