Key Principles
Principle | Decision / Discussion | Status |
---|---|---|
Aggregation |
| SPECIFIED |
Scope is Portfolio |
| SPECIFIED |
Unbundling / Legs |
| SPECIFIED |
Benchmark Data |
| SPECIFIED |
Breakdown Segments |
| SPECIFIED |
Figures |
| SPECIFIED |
Interface "PortfolioValuation"
Status | IMPLEMENTED | ||
---|---|---|---|
Usage & Contents | used to produce
contains
| ||
Path | /portfolio/valuation | ||
Parameters | portfolioId* | string | The id of the portfolio (or consolidation) in the data source |
reportingDate* | string (date) | The business date the valuations are queried for. | |
segmentationDate | string (date) | Date as of the instruments are segmented and the segmentation definition is valid (equals reportingDate if omitted) | |
Example call | /portfolio/valuation?portfolioId=E0002&reporting=2019-03-31&segmentationDate=2019-06-30 | ||
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* [P01] All figures used within a valuation object must be defined in the figures declaration * All figures having an aggregationMethod <> none have to match the top level figure value when aggregating up the positions * [P02] All segmentationIds referenced within positions must be defined in the Segmentations call * [P03] All segmentIds referenced within positions must be defined under the corresponding segmentation in the Segmentations call * All segmentIds referenced within positions must be "leaf-level" segments within the segmentation (no more child segments) | ||
Reporting Business Logic |
|
Interface "BenchmarkValuation"
Status | IMPLEMENTED | ||
---|---|---|---|
Usage & Contents | used to produce
contains
| ||
Path | /benchmark/valuation | ||
Parameters | benchmarkId* | string | The id of the benchmark in the data source |
reportingDate* | string (date) | ||
segmentationDate | string (date) | ||
Example call | /benchmark/valuation?benchmarkId=B0002&reportingDate=2019-03-31&segmentationDate=2019-06-30 | ||
Response structure | If the API can fulfill the request (response status code 200 = OK) the responst 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* [B01] All figures used within a valuation object must be defined in the figures declaration * All figures having an aggregationMethod <> none have to match the top level figure value when aggregating up the positions * [B02] All segmentationIds referenced within positions must be defined in the Segmentations call * [B03] All segmentIds referenced within positions must be defined under the corresponding segmentation in the Segmentations call * All segmentIds referenced within positions must be "leaf-level" segments within the segmentation (no more child segments) | ||
Reporting Business Logic |
|
0 Comments