C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.API.PortfolioViewMarginals Class Reference

Represents the endpoint on the server for requesting marginal portfolios. More...

Classes

class  MarginalPortfolioView
 The structure used to create a Marginal PortfolioView. More...
 

Static Public Member Functions

static IReference< PortfolioViewPost (IReference< PortfolioView > basePortfolio, IEnumerable< IReference< ILayerView > > layerViewsToAdd=null, IEnumerable< IReference< ILayerView > > layerViewsToRemove=null, IEnumerable< Parameter > requestParameters=null, int? timeout=null)
 Construct a "marginal" PortfolioView by adding and/or removing one or more LayerViews to/from some base PortfolioView.
 

Static Public Attributes

static readonly string PATH = "portfolio_view_marginals"
 The path of the endpoint for requesting marginal portfolios.
 

Properties

string Path [get]
 The relative path to this endpoint from the root URL.
 

Detailed Description

Represents the endpoint on the server for requesting marginal portfolios.

Definition at line 16 of file API.PortfolioViewMarginals.cs.

Inheritance diagram for AnalyzeRe.API.PortfolioViewMarginals:
AnalyzeRe.APITypes.IEndpoint

Member Function Documentation

◆ Post()

static IReference< PortfolioView > AnalyzeRe.API.PortfolioViewMarginals.Post ( IReference< PortfolioView basePortfolio,
IEnumerable< IReference< ILayerView > >  layerViewsToAdd = null,
IEnumerable< IReference< ILayerView > >  layerViewsToRemove = null,
IEnumerable< Parameter requestParameters = null,
int timeout = null 
)
inlinestatic

Construct a "marginal" PortfolioView by adding and/or removing one or more LayerViews to/from some base PortfolioView.

Parameters
basePortfolioThe PortfolioView to modify.
layerViewsToAddThe ILayerView references to add.
layerViewsToRemoveThe ILayerView references to remove.
requestParametersOptional - Additional parameters to include in the request.
timeoutOptional - The desired request timeout (in milliseconds).
Returns
Returns a reference to the marginal PortfolioView created by the server.

Definition at line 57 of file API.PortfolioViewMarginals.cs.

Member Data Documentation

◆ PATH

readonly string AnalyzeRe.API.PortfolioViewMarginals.PATH = "portfolio_view_marginals"
static

The path of the endpoint for requesting marginal portfolios.

Definition at line 19 of file API.PortfolioViewMarginals.cs.

Property Documentation

◆ Path

string AnalyzeRe.API.PortfolioViewMarginals.Path
get

The relative path to this endpoint from the root URL.

Implements AnalyzeRe.APITypes.IEndpoint.

Definition at line 22 of file API.PortfolioViewMarginals.cs.


The documentation for this class was generated from the following file: