01 Home
Please note, this page is under construction
... Product Owners, Application Managers, Project Managers, Business Analysts, Developers...
... all technically minded people interested in the functionalities of the NäBi-Service (NBS)
... give an insight of how the NBS works
... describe technical properties of the NBS
... allow interested stakeholders to integrate NBS in their respective services
... technical OpenApi documentation of the NBS
... SuisseBilanz (SuiBi) Guidance Ordinance on direct payments
... documentation of the calculation method
... defining the mandatory SuiBi inputs which are specified by the Ordinance on direct payments. This wiki solely describes the functions of the NBS, its API-endpoints and the required request body arrays, objects and fields which are necessary for the correct functionality.
... replacing documentation which is listed on the bulletpoint above
NBS aims to provide a backend calculation service for Farm Management Information Systems (FMIS). The service is intended to introduce a centrally maintained and Switzerland-wide standardized calculation methodology for the SuisseBilanz (SuiBi) and to align the current calculation with the latest scientific findings.
The different functionalities of the calculation service can be called up by the FMIS via specific Rest API endpoints:
- Calculate a Planning Balance
- Calculate a Control balance
- Retrieve master data for calculation input
- Retrieve digiFLUX-core data for calculation input
- Validate input data for calculation with transaction data from digiFLUX-core
- Save results of control balance in digiFLUX-core
- Change status of saved control balance in digiFLUX-core
- View calculation results of saved control balance in digiFLUX-core
If attributes of API-request and response body JSON-sctructure are defined in Swiss eCH-data standard, both terminology and object structure origin from the following eCH standards:
1. Hofdaten und Anwendung Betriebsmittel
- Flags in JSON-request and response body are characterized by an auxillary verb such as "has" or "is"
- Percentage input or output variables are characterized by the words "proportion", "content" or defined by a
unitentry
Terminology for Input Description
| term | meaning |
|---|---|
| mandatory | Input is mandatory if object body is not empty. If input is not given an error is generated. |
| optional | Input is optional if object body is not empty. If input is not given no error is generated. |
| forbidden | Input is not allowed and will generate error if declared. |
| conditional | In certain conditions input is mandatory or forbidden. If conditions are not met an error is generated. |
| dependency | Input possibility depends on input of other items. If conditions are not met an error is generated. |
NBS persists only of a backend layer. There is neither a frontend nor a database layer allowing FMIS to provide frontend solutions for customers. Subsequently NBS does not store any calculation results. However, dontrol balances can be transmitted from NBS to the digiFLUX-core service via API-endpoint, in order to be persisted.