Key Principles
Principle | Decision / Discussion | Status |
---|---|---|
Scope is Portfolio |
| SPECIFIED |
Benchmark Data |
| SPECIFIED |
Models & Figures |
| SPECIFIED |
Aggregation of instruments / segments |
| OUT OF SCOPE |
Interface "PortfolioRiskExPost"
Status | IMPLEMENTED | ||
---|---|---|---|
Usage & contents |
| ||
Path | /portfolio/riskexpost | ||
Parameters | portfolioId | string | The id of the portfolio (or consolidation) in the data source |
reportingDate | string (date) | The date, the reporing is produced for. | |
Example call | /portfolio/riskexpost?portfolioId=E0002&reportingDate=2019-03-31 | ||
Response structure | If the API can fulfill the request (response status code 200 = OK) the response must follow the below json-schema.
| ||
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
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: Consistency Rules* All figures used within a risk object should be defined in the figures declaration * All risk objects have to name a period that ends earlier than or at the reportingDate * All end dates of risk object periods have to be the same and have to be a month's ultimo date | ||
Reporting business logic |
| ||
Potential problems |
|
Interface "PortfolioRiskExAnte"
Status | IMPLEMENTED | ||
---|---|---|---|
Usage & contents | used to produce
Contents
| ||
Path | /portfolio/riskexante | ||
Parameters | portfolioId | string | The id of the portfolio (or consolidation) in the data source |
reportingDate | string (date) | The date, the reporing is produced for. | |
Example call | /portfolio/riskexante?portfolioId=E0002&reportingDate=2019-03-31 | ||
Response structure | If the API can fulfill the request (response status code 200 = OK) the response must follow the below json-schema.
| ||
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
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: Consistency Rules* All figures used within a risk object should be defined in the figures declaration * All risk objects have the same referenceDate * The referenceDate is not later than the reportingDate * A model referenced in a risk object has to be declared under models * Every effect used within a risk object has to be a declared effect of the referenced model * Every effect declared within a model has to be also declared as figure * All effects of a model having effectAggregation = sum should sum up to the value of the figure they explain | ||
Reporting business logic |
| ||
Potential problems |
Interface "PortfolioRiskStatus"
Status | IMPLEMENTED |
---|---|
Usage & contents | used to produce cover overviews |
Path | /portfolio/riskstatus |
Example call | /portfolio/riskstatus?portfolioId=E0002&reportingDate=2019-03-31 |
Response structure | "riskstatus": { "calcDate": "2019-03-31", "statusText": "moderate", "performanceHistoryMonths": 97, "SRRI": 3, "SRI": 2 } where
|
Schema | |
Error handling |
|
Parameters |
|
Consistency rules |
|
Reporting business logic | none |
Example | |
Potential problems |
Add Comment