SIVI All Finance Standard

5.2. Overview of all functions

Introduction

The SIVI AFS API-framework function overview contains two documents. One document contains all the functional functions of the SIVI AFS API-framework (based on the Category Functional of this framework). The other document contains all the technical functions of this framework (based on the Category Technica). For more information about Category and other elements of the SIVI AFS API-framework go to the Overview of the API-framework.
Each row in the document describes a complete API function. Every API function is divided in a Function section and an API Definition section.

Function

The Function section shows the functional part of the API function and contains the following components:

API Definition

The API Definition section shows the technical part of the API function and contains the following components:

  • Method – API operations (see Design principles):
    • POST – add a new dataset to the collection.
    • PUT – replace the whole dataset.
    • PATCH – replace a partial dataset.
    • GET – retrieve a dataset via HTTP parameters.
  • Path/Endpoint – Composition of the following elements:
    • The data set of the AFD structure.
    • If a specific subdataset is applicable, this is added to the endpoint, as well. If a specific ‘id’ of the requested data set is applicable, the ‘id’ of that data set is added here as a path parameter, for example /policies/{policyId}/change. If a second ‘id’ applies, the ‘id’of that subdata set is added here as a path parameter, as well, for example /master-agreements/{masterAgreementId}/contracts/{contractId}/change.
    • Variant
      • If the variant is equal to default, the endpoint ends with the operation.
      • In other cases the endpoint ends with the applicable variant and the operation is omitted, unless omitting the operation makes the endpoint non-unique.
      • In cases of variant ‘rate’ and ‘underwrite’, the endpoint does not end with the variant, but with the operation, for example /policies/{policyId}/rates/change.
  • Function variant – the code of the function variant in AFD according to the codelist APIVAR. It contains a code (e.g. A0300) and a short description (e.g. newClaim).
  • Request – the payload is included in the body of the request message and contains the business information (see Design principles).
  • Request function – the name of the corresponding request function.
  • Query parameter – query parameters are key value pairs that are appended to the URL of a resource.
  • Response – the output section is a functional description of the content of the response (see Design principles).
  • Response function – the name of the corresponding response function.

See for a more in depth explanation of path parameters and query parameters the Design principles.

Functional functions

All functions included in de SIVI API-framework in the functional category are listed below. A more detailed explanation of these functions will follow in the remainder of this chapter.


Figure 5.2-1 Function table with functional operations (click on the image to enlarge)


Technical functions

All functions included in de SIVI API-framework in the technical category are listed below. A more detailed explanation of these functions will follow in chapter Technical functions.


Figure 5.2-2 Function table with technical operations (click on the image to enlarge)