The operation retrieve will fetch a policy, loan, pension, master agreement or contract within an existing master agreement for a single entry, a range or a list of entries. The output consists of the structures needed in the particular situation, so it can be a policyStructure or a masterAgreementStructure (see also policyStructure and masterAgreementStructure).

Once a contract has been submitted, the data is available through the retrieve function. The variant is used to determine the scope of the required information.

How to use variants

If you want to retrieve a contract, choose the operation retrieve. If a particular handling variant is requested, use a variant. If not, select the default variant. The variant determines which attributes are mandatory.

The operation retrieve is a webservice call without a body. The functionVariant is included as a path parameter and the (range of) contractNumber is included as query parameter in the request. For more information see the Retrieve operations section of the Design principles chapter.

The output will contain a single masterAgreementStructure or policyStructure if only one id is specified, or an array of structures if more than one id is specified, or if no id is specified.

If a negative response is generated, that means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.

Variants

Variant Description policy
structure
masterAgreement
structure
pension
structure
loan
structure
<default> Obtain full details of a contract based on the unique reference Yes Yes U/C U/C
bookingList Obtain reference information of available bookings according to a query statement Yes Yes U/C U/C
documentList Obtain reference information of all available documents for one contract Yes Yes U/C U/C
documentRange Obtain documents for one contract based on a range of unique references Yes Yes U/C U/C
invoiceList Obtain reference information of available invoices according to a query statement Yes Yes U/C U/C
list Obtain reference information of all available contracts Yes Yes U/C U/C
offer Obtain full details of an offer of a contract based on the unique reference Yes Yes U/C U/C
offerList Obtain reference information of all available offers Yes Yes U/C U/C
offerRange Obtain details of multiple offers based on a range of unique references Yes Yes U/C U/C
range Obtain details of multiple contracts based on a range of unique references Yes Yes U/C U/C
financialMidTemChange Obtain financial booking resulting from the mid-term change of a contract (“PMB”) Yes Yes U/C U/C
status Obtain status information of a contract by a unique reference Yes Yes U/C U/C
statusOffer Obtain status information of an offer by a unique reference Yes Yes U/C U/C

U/C: Under construction.

<default> – Obtain full details of a contract based on the unique reference

The variant default retrieves all contract data using a unique reference.


policyStructure

The policyStructure is used to retrieve the complete policy using a unique reference. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/{policyId}/retrieve N/A N/A policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to retrieve the complete masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

It is possible to execute this operation for a subcontract by adding the contract number as a query parameter (contractnumber={contractId}). More information on query parameters is available in Design principles.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/retrieve N/A contractnumber={contractId} masterAgreementStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

bookingList – Obtain reference information of available bookings according to a query statement

The variant bookingList is used to retrieve a list of bookings of a contract. It is possible to request multiple fields.

policyStructure

The policyStructure is used to retrieve a list of all available bookings for a policy based on a query statement. For more information on query parameters refer to the Design principles. The mandatory attributes (in a generic form) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

To retrieve a list of all available bookings the query parameter ‘entityType=booking’ must always be included in the endpoint. This requirement is shown in the table below. More information on query parameters is available in the Design principles).

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/{policyId}/financialTransactions/list N/A _fields=[{attribute}]
_filter=entityType=booking];
_filter=[{attribute}|{operator}|{valueAttribute}]
policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.
financialTransaction.booking refKey O Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request a list of all available bookingsfor a specified masterAgreement based on a query statement. The mandatory attributes (in a generic form) are listed in the table Mandatory input and/or output (I/O) attributes.

To retrieve a list of all available bookings the query parameter ‘entityType = booking’ must always be included in the endpoint.

It is also possible to request bookings for a subcontract by adding the contract number as a query parameter (contractNumber={contractId}). For more information on query parameters, refer to the Design principles.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/financial-transactions/list N/A contractnumber={contractId}
_fields=[{attribute}]
_filter=[entityType=booking]
_filter=[{attribute}|{operator}|{valueAttribute}]
_sort=[{attribute}]
masterAgreementStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.
financialTransaction.booking refKey O The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

documentList – Obtain reference information of all available documents for one contract

The variant documentList is used to retrieve a list of all available documents of a contract. It is possible to request multiple fields. The sequenceNumber is always returned, even if no fields or attributes were requested.

policyStructure

The policyStructure is used to retrieve a list of all available documents for a policy based on a query statement. More information on query parameters is available in Design principles. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/{policyId}/documents/list N/A _fields=[{attribute}]
_filter=[{attribute}|{operator}|{valueAttribute}]
_sort=[{attribute}]
policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.
document sequenceNumber O The entity document is returned as a list.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request a list of all available offers for a specified masterAgreement based on a query statement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

It is possible to request documents of a subcontract by adding the contract number as a query parameter (contractNumber={contractId}). More information on query parameters is available in Design principles.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/documents/list N/A contractnumber={contractId}
_fields=[{attribute}]
_filter=[{attribute}|{operator}|{valueAttribute}]
_sort=[{attribute}]
masterAgreementStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.
document sequenceNumber O The entity document is returned as a list.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

documentRange – Obtain details of multiple documents for one contract based on a range of unique references

The variant documentRange is used to retrieve multiple documents of a contract, using a list of document numbers.


policyStructure

The policyStructure is used to retrieve multiple documents of a policy based on a query statement. More information on query parameters is available in Design principles. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/{policyId}/documents/range N/A documents=[{documentId}] policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to retrieve multiple documents of a masterAgreement based on a query statement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

If no contract number or documents are added to the query parameter, all documents of the master agreement and subcontracts are returned. If only the contract number is added, then all documents connected to this contract number will be returned. If no subcontract is requested, then all documents of the master agreement are returned. More information on query parameters is available in Design principles.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/documents/range N/A contractnumber={contractId}
documents=[{documentId}]
masterAgreementStructure

If no document numbers are used, all documents for the selected masterAgreement are retrieved.


Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

invoiceList – Obtain reference information of available invoices according to a query statement

The variant invoiceList is used to retrieve a list of invoices of a contract. It is possible to request multiple fields.

policyStructure

The policyStructure is used to retrieve a list of all available invoices for a policy, based on a query statement. The mandatory attributes (in a generic form) are listed in the table Mandatory input and/or output (I/O) attributes. For more information on query parameters, refer to the Design principles.

Endpoint definition

To retrieve a list of all available invoices, the query parameter ‘entityType=invoice’ must always be included in the endpoint. This requirement is illustrated in the table below. More information on query parameters is available in he Design principles.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/{ policyId &#125/financial-informations/list N/A _fields=[{attribute}]
_filter=[entityType=invoice]
_filter=[{attribute}|{operator}|{valueAttribute}]
policyStructure

For more information about query parameters, see Design principles


Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.
financialTransaction.invoice refKey O Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request a list of available invoices for a specified masterAgreement, based on a query statement. The mandatory attributes (in a generic form) are listed in the table Mandatory input and/or output (I/O) attributes.
To retrieve a list of all available invoices the query parameter ‘entityType=invoice’ must always be included in the endpoint.
It is also possible to request invoices for a subcontract by adding the contract number as a query parameter (‘contractnumber=[{contractId}’). More information on query parameters is available in he Design principles.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/financial-informations/list N/A contractnumber=[{contractId}]
_fields=[{attribute}]
_filter=[{attribute}|{operator}|{valueAttribute}]
_sort=[{attribute}]
masterAgreementStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.
financialTransaction.invoice refKey O Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

list – Obtain reference information of all available contracts

The variant list is used to retrieve a list of contracts, using the contract number by default, but this can be extended by a certain number of extra attributes.

policyStructure

The policyStructure is used to retrieve a list of policies based on a query statement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes. More information on query parameters is available in Design principles.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/list N/A _fields=[{attribute}]
_filter=[{attribute}|{operator}|{valueAttribute}]
policyStructure

For more information about query parameters, see Design principles


Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to retrieve a list of masterAgreements based on a query statement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, no path parameter is included in the endpoint. This is shown in the table below. More information on query parameters is available in Design principles.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/list N/A _fields=[{attribute}]
_filter=[{attribute}|{operator}|{valueAttribute}]
masterAgreementStructure



If not the complete masterAgreement is subject to this operation and variant but only a particular contract within that masterAgreement, a path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below. More information on query parameters is available in Design principles.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/list N/A _fields=[{attribute}]
_filter=[{attribute}|{operator}|{valueAttribute}]
masterAgreementStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

offer – Obtain full details of an offer of a contract based on the unique reference

The variant offer is used to retrieve all data of the offer, using a unique reference.

policyStructure

The policyStructure is used to retrieve all data of an offer for a policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/offers/{offerId}/retrieve N/A N/A policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy offerNumber O Number of the offer. 

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to retrieve all data of an offer for a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If an offer for a complete masterAgreement (including the underlying contracts) is subject to this operation, one path parameter ({offerId}) is included in the endpoint. This is shown in the table below.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/offers/{offerId}/retrieve N/A N/A masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within a masterAgreement, two path parameters ({offerId} and {masterAgreementId}) are included in the endpoint. This is shown in the table below.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/offers/{offerId}/retrieve N/A N/A masterAgreementStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O** Number of the masterAgreement contract. Please note: only applicable with a retrieve offer policy.
masterAgreement offerNumber O** Number of the offer. Please note: only applicable with a retrieve offer masterAgreement.
policy offerNumber O** Number of the offer. Please note: only applicable with a retrieve offer policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

offerList – Obtain reference information of all available offers

The variant offerList is used to retrieve a list of all available offers for a contract based on a query statement. It is possible to request multiple fields. The offerNumber is always returned, even if no fields or attributes were requested.

policyStructure

The policyStructure is used to retrieve a list of all available offers for a policy based on a query statement. More information on query parameters is available in Design principles. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/offers/list N/A _fields=[{attribute}]
_filter=[{attribute}|{operator}|{valueAttribute}]
policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy offerNumber O Number of the offer. 

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request a list of all available offers for a specified masterAgreement based on a query statement. More information on query parameters is available in Design principles. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/offers/list N/A _fields=[{attribute}]
_filter=[{attribute}|{operator}|{valueAttribute}]
masterAgreementStructure

If no query parameters are used, all offers of this masterAgreement will be returned. More information on query parameters is available in Design principles.


Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O** Number of the masterAgreement contract. Please note: only applicable with a retrieve offer policy.
masterAgreement offerNumber O** Number of the offer. Please note: only applicable with a retrieve offer masterAgreement.
policy offerNumber O** Number of the offer. Please note: only applicable with a retrieve offer policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

offerRange – Obtain details of multiple offers based on a range of unique references

The variant offerRange is used to retrieve multiple offers for a contract, using a list of offer numbers.


policyStructure

The policyStructure is used to retrieve multiple offers for a policy based on a query parameter. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes. More information on query parameters is available in Design principles.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/offers/range N/A offers=[{offerId}] policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy offerNumber O Number of the offer. 

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to retrieve multiple offers for a masterAgreement based on a query parameter. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, no path parameter is included in the endpoint. This is shown in the table below. More information on query parameters is available in Design principles.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/offers/range N/A offers=[{offerId}] masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, a path parameter ({masterAgreementId}) is added to the endpoint. This is shown in the table below.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/offers/range N/A offers=[{offerId}] masterAgreementStructure

If no offer numbers are used as a query parameter, all offers for the selected masterAgreement are retrieved. More information on query parameters is available in Design principles.


Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O** Number of the masterAgreement contract. Please note: only applicable with a retrieve offer policy.
masterAgreement offerNumber O** Number of the offer. Please note: only applicable with a retrieve offer masterAgreement.
policy offerNumber O** Number of the offer. Please note: only applicable with a retrieve offer policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

range – Obtain details of multiple contracts based on a range of unique references

The variant range is used to retrieve details of multiple contracts based on a range of unique references.


policyStructure

The policyStructure is used to retrieve details of multiple policies based on a range of unique references. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes. More information on query parameters is available in Design principles.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/range N/A contracts=[{contractId}] policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to retrieve details for multiple contracts within a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, no path parameter is included in the endpoint. This is shown in the table below. More information on query parameters is available in Design principles.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/range N/A contracts=[{contractId}] masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a range of particular contract within that masterAgreement, a path parameter ({masterAgreementId}) is added to the endpoint. This is shown in the table below.

Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/range N/A contracts=[{contractId}] masterAgreementStructure

If no contract numbers are used as a query parameter, all contracts of the selected masterAgreement will be retrieved.


Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

financialMidTermChange – Obtain financial booking resulting from the mid-term change of a contract (“PMB”)

The variant financialMidTermChange returns the financial result of a mid-term change in an existing contract.

policyStructure

The policyStructure is used to return the financial result of a mid-term change for a policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/{policyId}/financial-mid-term N/A N/A policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.
policy effectiveChangeDate O Effect date of the change itself.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to return the financial result of a mid-term change for a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/{masterAgreementId}/financial-mid-term N/A contractnumber = {contractId} masterAgreementStructure

If no contract numbers are used as a query parameter, all contracts of the selected masterAgreement will be retrieved. More information on query parameters is available in Design principles.

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
masterAgreement effectiveChangeDate O** Effect date of the change itself. Please note: only applicable with a retrieve masterAgreement.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve policy.
policy effectiveChangeDate O** Effect date of the change itself. Please note: only applicable with a retrieve policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

status – Obtain status information of a contract by a unique reference

The variant status retrieves the status of the process and the contract.

policyStructure

The policyStructure is used to retrieve the status of the policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/{policyId}/retrieve/status N/A N/A policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy contractNumber O The identifying characteristic assigned by a company or underwriting agent.
policy statusType O The status of the policy (codelist ADNSTS) within the entityType policyDetails.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to retrieve the status of the masterAgreement based on a query parameter. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements//{masterAgreementId}/retrieve/status N/A contractnumber={contractId} masterAgreementStructure

If no contract numbers are used as a query parameter, all contracts of the selected masterAgreement will be retrieved. More information on query parameters is available in Design principles.

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O Number of the masterAgreement contract.
masterAgreement statusType O** The status of the masterAgreement (codelist ADNSTS). Please note: only applicable with a retrieve status masterAgreement.
policy contractNumber O** The identifying characteristic assigned by a company or underwriting agent. Please note: only applicable with a retrieve status policy.
policy statusType O** The status of the policy (codelist ADNSTS) within the entityType policyDetails. Please note: only applicable with a retrieve status policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

statusOffer – Obtain status information of an offer by a unique reference

The variant statusOffer is used to request the status of an offer (using an {offerId}).

policyStructure

The policyStructure is used to request the status of an offer for a policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/policies/offers/{offerId}/status N/A N/A policyStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
policy offerNumber O Number of the offer. 
policy statusType O The status of the policy (codelist ADNSTS) within the entityType policyDetails.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request the status of an offer for the masterAgreement based on a query parameter. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
parameter(s)
Response Remarks
GET { uri }/master-agreements/offers/{offerId}/status N/A contractnumber={contractId} masterAgreementStructure

If no contract numbers are used as a query parameter, all contracts of the selected masterAgreement will be retrieved. More information on query parameters is available in Design principles.

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion O Version of the data catalog on which the message is based.
commonFunctional functionVariant O The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional businessLine O Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional porCompany O The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional afdDefinitionName O Name of the AFD-definition.
commonFunctional afdDefinitionVersion O Version of the AFD-definition.
masterAgreement contractNumber O** Number of the masterAgreement contract. Please note: only applicable with a retrieve offer status policy.
masterAgreement offerNumber O** Number of the offer. Please note: only applicable with a retrieve offer status masterAgreement.
masterAgreement statusType O** The status of the masterAgreement (codelist ADNSTS). Please note: only applicable with a retrieve offer status masterAgreement.
policy offerNumber O** Number of the offer. Please note: only applicable with a retrieve offer status policy.
policy statusType O** The status of the policy (codelist ADNSTS) within the entityType policyDetails. Please note: only applicable with a retrieve offer status policy.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

Feedback

Thanks for your feedback.

Post your comment on this topic.

Please do not use this for support questions.
If you have any support questions, do not hesitate to contact us.

Post Comment