The table below shows the functions included in the API-framework.

Table legend:

Function group A set of functions which operate on the same functional object.
Function The base operation for supplying, changing or fetching the data of a functional object.
Variant A functional appearance of the base operation, providing additional control for preceding/succeeding workflow steps. The value is registered in the functionVariant attribute.
For instance a new policy, based on an existing offer; part of the policy data is taken from the offer, and the offer can subsequently be terminated.
Meaning The circumstances for which a certain functionVariant was designated.
AFD-structure Definition of the data structure that must be used in the body section of the request and/or response message.

The table below shows the functions with the endpoints included in the API-framework.

Table legend:

Function group A set of functions which operate on the same functional object.
Function The base operation for supplying, changing or fetching the data of a functional object.
Variant A functional appearance of the base operation, providing additional control for preceding/succeeding workflow steps. The value is registered in the functionVariant attribute.
For instance a new policy, based on an existing offer; part of the policy data is taken from the offer, and the offer can subsequently be terminated.
API Operation HTTP methods (POST, PUT, PATCH, GET) used to manipulate resources (represented by an endpoint).
API Endpoint Resource location and destination for sending API request.
API Payload Business content contained in an API request- or response message body.
API Parameters Variable part of an endpoint used to determine the type of action to be taken on the resource.
API Response HTTP status code and message body (if applicable) with business content.
Meaning The circumstances for which a certain functionVariant was designated.
AFD-structure Definition of the data structure that must be used in the body section of the request and/or response message.

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment