Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for ETag header in the us-address-enrichment-api #24

Open
RyanLCox1 opened this issue Sep 12, 2024 · 0 comments
Open

Add support for ETag header in the us-address-enrichment-api #24

RyanLCox1 opened this issue Sep 12, 2024 · 0 comments

Comments

@RyanLCox1
Copy link
Collaborator

We need to support the ETag header in the enrichment api. Here's the purpose and usage:

The ETag header provides the ability to check if a record has been updated since the last query.

Every query to the API will return an ETag header which represents a hash of the record in the response. This value may be stored and used in subsequent queries for that same record.

If the record data has NOT been updated since the last query, it will return a 304 (Not Modified) and the client will not be charged for the query. (The 304 response does not contain a body.)

If the record data HAS been updated, the latest version of the record will be returned along with a new ETag value.

Important: Only the latest ETag value is valid for each record. This feature is NOT designed to retrieve past record versions. Also note that the ETag value will change if ANY data in the record has been updated, regardless of which attributes are requested using the include and exclude parameters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant