Resource Representation Parameters in Request Body

Oracle Health Insurance plans to remove the ability to specify the resource representation parameters in the request message 'Accept' header.

This change applies to all Oracle Health Insurance components.
Date of deprecation: 2023-01-05

What is deprecated?

The ability to pass parameters that influence the resource representation in the 'Accept' header of an HTTP request is deprecated.

This is replaced by the ability to set the resource representation parameters in the request body.

Suggested actions

Revisit all integrations built on the generic HTTP API and move the following parameters from the request header to the request body:

  • response

  • expand

  • fields

  • aliases

  • defaultoverride.

The parameter names are the same in the body as well as in the header. In the body, these parameters are specified under the attribute "resourceRepresentation".

If the body includes the attribute "resourceRepresentation", the application ignores all resource representation parameters in the accept header.

Instead of

Accept: application/vnd.oracle.insurance.resource+json; fields=officeAddress

Use

Header
 POST http://[hostName]:[portNumber]/[api-context-root]/generic/persons/search
Body
{
"resource": {
"q": "dateOfBirth.eq('1900-01-01').and.name.eq('Doe')"
},
"resourceRepresentation": {
"fields": "officeAddress"
}
}