Fetch (part of) the data for a single offer, a range, or a list of all offers.
Once a offer has been submitted, the data is available through the retrieve function. The variant is used to determine the scope of the required information.
The actual offer in for instance PDF format may be included in the response (see the policyStructure section for more details).
|1||single||Obtain full details of a single offer based on the unique offer reference.|
|2||status||Obtain the status of a single offer based on the unique offer reference.|
|3||range||Obtain details of multiple offers based on a range of unique offer references.|
|4||list||Obtain references of all offers available within the authorization restrictions.|
The variants single and list are considered the minimal requirements for this function.
Technical specifications: retrieveOffer
The retrieve function is a webservice call without a body. The
functionVariant and the (range of)
offerNumber are included in the query parameters in the request header.
For more information see the Retrieve functions section of the Design principles chapter.
The output will contain a single offer (in a
policyStructure) when only one id is specified, or an array of offers when more than one id is specified, or none at all.
If no offers are found based on the query, or if currently none exist at all, a ‘No Content’ (HTTP 204) response will be returned. See also the Error section below.
There are three basic types of output which are described in the Output section of the Design principles chapter. If the response message contains a body section, it will be based on the
variant column indicates the required attributes for specific variants.
|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.|
|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.|
|offerNumber||4||string||Identification/sequence number of the offer.|
|status||2||string||Current status of the offer.|
|…||Any additional attributes within the
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)