5.6.3. Retrieve

The operation retrieve in case of a party will fetch the data of that party.

How to use variants

The operation retrieve is a webservice call without a body.

For more information see the Retrieve operations section of the Design principles chapter.

The output of the retrieve operation uses the partyStructure as described in the partyStructure section.

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

The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.

<default> – Obtain party information

The variant default retrieves party information based on a unique reference, using the partyStructure. 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 } /parties/{partyId}/retrieve	N/A	N/A	partyStructure

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	afdDefinitionName	O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	O	Version of the AFD-definition.
party	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.

list – Obtain reference information of all available parties

The variant list is used to retrieve a list of parties. 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 party is subject to the operation retrieve, 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 } /parties/list	N/A	_fields=[{attribute}], _filter=[{attribute}|{operator}|{valueAttribute}]	partyStructure

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	afdDefinitionName	O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	O	Version of the AFD-definition.
party	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.

masterAgreementList – Obtain reference information of masterAgreements of a party

The variant masterAgreementList is used to retrieve a list of masterAgreements of a party. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If masterAgreements of a party need to be retrieved, the endpoint below is available. A subselection can be requested with the query parameter _filter. If it is not provided then all masterAgreements of the party will be returned. Some extra attributes can be requested using the query parameter _fields. If it is not provided only the id (contractNumber) will be returned. For each contract found, an entity within the structure will be returned. More information on query parameters is available in Design principles.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
GET	{ uri } /parties/{partyId}/master-agreements/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	afdDefinitionName	O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	O	Version of the AFD-definition.
party	refKey	O	Unique reference key assigned to an entity.
masterAgreement	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.

policyList – Obtain reference information of policies of a party

The variant policyList is used to retrieve a list of policies of a party. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If policies of a party need to be retrieved, the endpoint below is available. A subselection can be requested with the query parameter _filter. If it is not provided then all policies of the party will be returned. Some extra attributes can be requested using the query parameter _fields. If it is not provided only the id (contractNumber) will be returned. For each contract found, an entity within the structure will be returned. More information on query parameters is available in Design principles.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
GET	{ uri } /parties/{partyId}/policies/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	afdDefinitionName	O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	O	Version of the AFD-definition.
party	refKey	O	Unique reference key assigned to an entity.
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.

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

The variant range is used to retrieve details of multiple parties 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 } /parties/range	N/A	parties=[partyId]	partyStructure

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	afdDefinitionName	O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	O	Version of the AFD-definition.
party	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.