Function: retrieveAfsTable

Fetching data in a tabular structure for use in automated processes and user dialogs.

Usage: retrieveAfsTable

Automated processes often use codelists to enforce the use of valid values for a specific attribute and keep the dataset compact. In a screen dialog this is represented by a drop-down list which shows the available options, for example to select the car make and model for car insurance. In post process situations the codes may be used to fetch the corresponding description or text(s) defined in the codelist(s), for instance the complete text of a condition or clause which is referred to on the policy by a code.
The retrieveAfsTable function allows a party to fetch a complete table with codes and corresponding descriptions, which can be incorporated in the proprietary environment of that party. This can be done periodically and/or after a notification that a new version is available. This setup enables the party to display the correct information from the source, and ensures that correct and valid information is incorporated in subsequent processes.

The data is selected by providing the tableName in the query header of the request.
The conditions table for example, can be added in the underwriting process, both manually or by an automated process. This is done by adding the reference(s) for the condition(s) to the policy data. When the policy is drawn up at a later stage, the full text of the conditions needs to be added. This requires that the agent or third party application has access to a table containing both the reference from the insurance provider, and the corresponding text.

And the clauses table can be added in the underwriting process, both manually or by an automated process. This is done by adding the reference(s) for the clause(s) to the policy data. When the policy is drawn up at a later stage, the full text of the clauses needs to be added in the same way as the conditions above.
The user may add variables in the clause text like a start or end date, or a specific description of an object for example. The variable must be added in AFD compliant notation (a XPath or JSONPath expression).

Insurance providers can also make other relevant tables available.

Technical specifications: retrieveAfsTable

Input: retrieveAfsTable

The retrieveAfsTable function is a webservice call without a body. The specific table is selected by supplying the tableName in the path parameter of the request header.
For more information see the Retrieve functions section of the Design principles chapter.

Output: retrieveAfsTable

The output of the retrieveAfsTable function uses the afsTableStructure as described in the afsTableStructure section.

Name Occur. Type Description
afsTableStructure 1..1 Structure of exchanging data in a tabular structure.
afsTable 1..1 Entity for grouping data as data in itself.
entityType 1..1 string Set to ‘table’.
tableName 1..1 string Name of the table or data set.
afsTable 1..* Entity for grouping data as data in itself.
entityType 1..1 string Set to ‘tableRow’.

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.

The Open Api Specification (3.0.0)

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment