Function: changeOffer

Request for change of a previously issued (and still valid) offer by an insurance provider.

Usage: changeOffer

An offer is often the start of a process of consideration and negotiation. As a result, the offer may be subject to change. For example, coverage can be extended or reduced, the insured amount may be changed, or a different/additional coverage is chosen. Depending on the amount of change, only the affected attributes can be updated, or the complete dataset. See also the Change functions section of the Design principles chapter.
The offer process can also be ended by the fact that it is not accepted or declined by the client. In that case the offer is kept in the system of record, but gets a status to indicate that it is no longer active. Removal of the offer after a mandatory retention period is an internal process which is not supported by the (public) API. See also the Delete functions section of the Design principles chapter.

# Variant Description
1 correction Meant to replace the entire offer by a new version.
2 update Used to apply a partial change to the offer.
3 cancellation The offer has not been accepted or was declined.

Input: changeOffer

The offerNumber must be supplied in the path header parameter. The functionVariant parameter directing the change is included in the body.

Name Variant Type Description
policyStructure
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
dataCatalogVersion all ADNAFM The version of the data catalog serves to validate correctness of the input and output data.
functionVariant all APIVAR The function variant is used to determine the additional set of required and optional input and output data.
policy With entityType policyDetails.
businessLine all ADNBRA Classification of the type of contract. E.g. to be used for addressing within a company.
porCompany all PORMAA The identification of the insurer is necessary to find the correct product and rate combination.
afdDefinitionName all string Name of the AFD-definition.
afdDefinitionVersion all string Version of the AFD-definition.
Additional information within the policy structure with regard to the change

Output: changeOffer

There are three basic types of output which are described in the Output section of the Design principles chapter.

A positive response for the changeOffer function may contain a dataset.
In order to simplify processing it is advised that the input data is returned in the output for reference. Any additional information that was collected during the transaction may also be added to the output for reference.
Changing an offer will often result in a change of premium, and if that is the case, the concerning premium attributes are relevant for the response message.
A change can also be necessary because of an correction in a name or description, which does not affect the premium. This can apply to any attribute of the offer.
And in a situation where an offer is declined, the offer status is the key attribute.

Name Variant Type Description
policyStructure
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
dataCatalogVersion all ADNAFM Version of the data catalog on which the message is based.
functionVariant all APIVAR Variant is used to determine the additional set of required and optional input and output data.
policy With entityType policyDetails.
businessLine all ADNBRA Classification of the type of contract. E.g. to be used for addressing within a company.
porCompany all PORMAA The identification of the insurer is necessary to find the correct product and rate combination.
afdDefinitionName all string Name of the AFD-definition.
afdDefinitionVersion all string Version of the AFD-definition.
referralNumber all string The number assigned to refer. The insurer / underwriting agent can determine which attribute is used for this.
Any additional attributes within the policyStructure.

Errors

When a negative response is generated, it follows the general rules as described in the Error section of the Status codes and error handling chapter.

Click below to see the Open Api Specification (3.0.0)

Under construction.

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment