Skip to end of metadata
Go to start of metadata

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 FeatureEd-Fi ImplementationExplanation

Case Sensitivity

/students?firstName=JOHN 
/students?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/v3/ed-fi/students

or …

https://example.com/api/v3/ed-fi/students

The API major version number should be specified in the base URI.


 


For more information on ETags, see here and IETF RFC 7232, Section 2.3 here. 


API Guidelines Contents

Find out more about the Ed-Fi API Design & Implementation Guidelines:

  • No labels