[ARCHIVE] Error responses and x-v and x-fapi-interaction-id headers

Archived 2022.11.20. Content moved to error scenarios and responses.

Question

Are x-v and x-fapi-interaction-id required as HTTP response headers when an API call encounters an error condition, that is, a status code other than 200?

In CDS Response headers, when a response with status 200 is generated from an API call, the x-v and x-fapi-interaction-id are listed.

However, returning an error, for example a 403 code, CDS Response headers does not list any required response headers. 

Answer

The x-v header represents the version of the payload response. It does not apply for error responses where a payload is not returned.

FAPI R/W requires x-fapi-interaction-id to be returned for successful and error responses. It is used as a correlation identifier between client request and server response.

See:

• CDS Response Headers
• FAPI R/W