Key Principles
Principle | Decision / Discussion |
---|
Status
Interface "PortfolioGuidelineAnalysis"
...
Status
...
Usage & Contents |
| ||
---|---|---|---|
Reporting Business Logic | |||
Consistency rules | The following rules should be adhered to by any response and will eventually be checked when consuming a response: tbd | ||
Path |
| ||
Parameters |
| string | The id of the portfolio (or consolidation) in the data source |
| string (date) | The reporting date the reporting is produced for | |
Example call |
|
Response structure
If the API can fulfill the request (response status code 200 = OK) the response must follow the below json-schema.
The request part of the response has to match the path and parameters used in the API call/request
The json schema currently excludes the schema for dataVersioning (should be designed by CSAM)
Schema
Error handling
If the request can't be fulfilled an appropriate response status code (4xx or 5xx) must be used. Possible errors could be
bad request structure → expected status = 400
portfolioId not found or reportingDate in future → expected status = 404
etc.
The body of the response should contain information about the reason of the error in plain text or as json object.
Consistency rules
The following rules should be adhered to by any response and will eventually be checked when consuming a response:
Schema |
| ||||||
---|---|---|---|---|---|---|---|
Example |
|