API Responses & Caching

Cache-Control

Response headers returned by the API are used to determine how long the response should be cached.

Cache-Control: max-age=60

HTTP ETag

All responses from the API will also include an ETag header (that is a checksum of the response body). If this is replayed to the API subsequent requests in the if-none-match header, then a 409 will be returned by the API if the response body has not changed. This is intended to reduce the over-the-wire response size and therefore to improve the responsiveness of the application on a mobile network.

For example:

ETag: 996521afd769f7f84538f0d7ecacaeab0a31b6ca

Will return an empty body and a response if the following is included in subsequent requests for the same resource:

if-none-match: 996521afd769f7f84538f0d7ecacaeab0a31b6ca