LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IQuotesApiSync Interface Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.IQuotesApiSync:
Inheritance graph
[legend]

Public Member Functions

QuoteAccessMetadataRule DeleteQuoteAccessMetadataRule (string scope, string? provider=default(string?), string? priceSource=default(string?), string? instrumentIdType=default(string?), string? instrumentId=default(string?), string? quoteType=default(string?), string? field=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule More...
 
ApiResponse< QuoteAccessMetadataRuleDeleteQuoteAccessMetadataRuleWithHttpInfo (string scope, string? provider=default(string?), string? priceSource=default(string?), string? instrumentIdType=default(string?), string? instrumentId=default(string?), string? quoteType=default(string?), string? field=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule More...
 
AnnulQuotesResponse DeleteQuotes (string scope, Dictionary< string, QuoteId >? requestBody=default(Dictionary< string, QuoteId >?), int operationIndex=0)
 DeleteQuotes: Delete quotes More...
 
ApiResponse< AnnulQuotesResponseDeleteQuotesWithHttpInfo (string scope, Dictionary< string, QuoteId >? requestBody=default(Dictionary< string, QuoteId >?), int operationIndex=0)
 DeleteQuotes: Delete quotes More...
 
GetQuotesResponse GetQuotes (string scope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), Dictionary< string, QuoteSeriesId >? requestBody=default(Dictionary< string, QuoteSeriesId >?), int operationIndex=0)
 [EARLY ACCESS] GetQuotes: Get quotes More...
 
ApiResponse< GetQuotesResponseGetQuotesWithHttpInfo (string scope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), Dictionary< string, QuoteSeriesId >? requestBody=default(Dictionary< string, QuoteSeriesId >?), int operationIndex=0)
 [EARLY ACCESS] GetQuotes: Get quotes More...
 
QuoteAccessMetadataRule GetQuotesAccessMetadataRule (string scope, string? provider=default(string?), string? priceSource=default(string?), string? instrumentIdType=default(string?), string? instrumentId=default(string?), string? quoteType=default(string?), string? field=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule More...
 
ApiResponse< QuoteAccessMetadataRuleGetQuotesAccessMetadataRuleWithHttpInfo (string scope, string? provider=default(string?), string? priceSource=default(string?), string? instrumentIdType=default(string?), string? instrumentId=default(string?), string? quoteType=default(string?), string? field=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule More...
 
ResourceListOfQuote ListQuotes (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [DEPRECATED] ListQuotes: List quotes More...
 
ApiResponse< ResourceListOfQuoteListQuotesWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [DEPRECATED] ListQuotes: List quotes More...
 
ResourceListOfQuoteAccessMetadataRule ListQuotesAccessMetadataRules (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope More...
 
ApiResponse< ResourceListOfQuoteAccessMetadataRuleListQuotesAccessMetadataRulesWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope More...
 
ResourceListOfQuote ListQuotesForScope (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 ListQuotesForScope: List quotes for scope More...
 
ApiResponse< ResourceListOfQuoteListQuotesForScopeWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 ListQuotesForScope: List quotes for scope More...
 
QuoteAccessMetadataRule UpsertQuoteAccessMetadataRule (string scope, UpsertQuoteAccessMetadataRuleRequest upsertQuoteAccessMetadataRuleRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule. This creates or updates the data in LUSID. More...
 
ApiResponse< QuoteAccessMetadataRuleUpsertQuoteAccessMetadataRuleWithHttpInfo (string scope, UpsertQuoteAccessMetadataRuleRequest upsertQuoteAccessMetadataRuleRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule. This creates or updates the data in LUSID. More...
 
UpsertQuotesResponse UpsertQuotes (string scope, Dictionary< string, UpsertQuoteRequest >? requestBody=default(Dictionary< string, UpsertQuoteRequest >?), int operationIndex=0)
 UpsertQuotes: Upsert quotes More...
 
ApiResponse< UpsertQuotesResponseUpsertQuotesWithHttpInfo (string scope, Dictionary< string, UpsertQuoteRequest >? requestBody=default(Dictionary< string, UpsertQuoteRequest >?), int operationIndex=0)
 UpsertQuotes: Upsert quotes More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteQuoteAccessMetadataRule()

QuoteAccessMetadataRule Lusid.Sdk.Api.IQuotesApiSync.DeleteQuoteAccessMetadataRule ( string  scope,
string?  provider = default(string?),
string?  priceSource = default(string?),
string?  instrumentIdType = default(string?),
string?  instrumentId = default(string?),
string?  quoteType = default(string?),
string?  field = default(string?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule

Delete the Quote Access Metadata Rule that exactly matches the provided identifier parts

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
providerThe Provider of the rule (optional)
priceSourceThe PriceSource of the rule (optional)
instrumentIdTypeThe InstrumentIdType of the rule (optional)
instrumentIdThe InstrumentId of the rule (optional)
quoteTypeThe QuoteType of the rule (optional)
fieldThe Field of the rule (optional)
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
operationIndexIndex associated with the operation.
Returns
QuoteAccessMetadataRule

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ DeleteQuoteAccessMetadataRuleWithHttpInfo()

ApiResponse<QuoteAccessMetadataRule> Lusid.Sdk.Api.IQuotesApiSync.DeleteQuoteAccessMetadataRuleWithHttpInfo ( string  scope,
string?  provider = default(string?),
string?  priceSource = default(string?),
string?  instrumentIdType = default(string?),
string?  instrumentId = default(string?),
string?  quoteType = default(string?),
string?  field = default(string?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)

[EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule

Delete the Quote Access Metadata Rule that exactly matches the provided identifier parts

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
providerThe Provider of the rule (optional)
priceSourceThe PriceSource of the rule (optional)
instrumentIdTypeThe InstrumentIdType of the rule (optional)
instrumentIdThe InstrumentId of the rule (optional)
quoteTypeThe QuoteType of the rule (optional)
fieldThe Field of the rule (optional)
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of QuoteAccessMetadataRule

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ DeleteQuotes()

AnnulQuotesResponse Lusid.Sdk.Api.IQuotesApiSync.DeleteQuotes ( string  scope,
Dictionary< string, QuoteId >?  requestBody = default(Dictionary< string, QuoteId >?),
int  operationIndex = 0 
)

DeleteQuotes: Delete quotes

Delete one or more specified quotes from a single scope. A quote is identified by its unique id which includes information about the type of quote as well as the exact effective datetime (to the microsecond) from which it became valid. In the request each quote must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote could not be deleted. It is important to always check the failed set for any unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the quotes to delete.
requestBodyThe quotes to delete keyed by a unique correlation id. (optional)
operationIndexIndex associated with the operation.
Returns
AnnulQuotesResponse

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ DeleteQuotesWithHttpInfo()

ApiResponse<AnnulQuotesResponse> Lusid.Sdk.Api.IQuotesApiSync.DeleteQuotesWithHttpInfo ( string  scope,
Dictionary< string, QuoteId >?  requestBody = default(Dictionary< string, QuoteId >?),
int  operationIndex = 0 
)

DeleteQuotes: Delete quotes

Delete one or more specified quotes from a single scope. A quote is identified by its unique id which includes information about the type of quote as well as the exact effective datetime (to the microsecond) from which it became valid. In the request each quote must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote could not be deleted. It is important to always check the failed set for any unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the quotes to delete.
requestBodyThe quotes to delete keyed by a unique correlation id. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of AnnulQuotesResponse

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ GetQuotes()

GetQuotesResponse Lusid.Sdk.Api.IQuotesApiSync.GetQuotes ( string  scope,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  maxAge = default(string?),
Dictionary< string, QuoteSeriesId >?  requestBody = default(Dictionary< string, QuoteSeriesId >?),
int  operationIndex = 0 
)

[EARLY ACCESS] GetQuotes: Get quotes

Get one or more quotes from a single scope. Each quote can be identified by its time invariant quote series id. For each quote series id LUSID will return the most recent quote with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for a quote from the specified effective datetime. LUSID will return the most recent quote within this window. In the request each quote series id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return three collections. One, the successfully retrieved quotes. Two, those that had a valid quote series id but could not be found. Three, those that failed because LUSID could not construct a valid quote series id from the request. For the quotes that failed or could not be found a reason will be provided explaining why the quote could not be retrieved. It is important to always check the failed and not found sets for any unsuccessful results. The maximum number of quotes that this method can get per request is 2,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the quotes to retrieve.
effectiveAtThe effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote if not specified. (optional)
maxAgeThe duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime or cut label to generate a effective datetime window inside which a quote must exist to be retrieved. (optional)
requestBodyThe time invariant quote series ids of the quotes to retrieve. These need to be keyed by a unique correlation id allowing the retrieved quote to be identified in the response. (optional)
operationIndexIndex associated with the operation.
Returns
GetQuotesResponse

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ GetQuotesAccessMetadataRule()

QuoteAccessMetadataRule Lusid.Sdk.Api.IQuotesApiSync.GetQuotesAccessMetadataRule ( string  scope,
string?  provider = default(string?),
string?  priceSource = default(string?),
string?  instrumentIdType = default(string?),
string?  instrumentId = default(string?),
string?  quoteType = default(string?),
string?  field = default(string?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule

Get a specific quote access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
providerThe Provider of the rule (optional)
priceSourceThe PriceSource of the rule (optional)
instrumentIdTypeThe InstrumentIdType of the rule (optional)
instrumentIdThe InstrumentId of the rule (optional)
quoteTypeThe QuoteType of the rule (optional)
fieldThe Field of the rule (optional)
effectiveAtThe effective date of the rule (optional)
asAtThe asAt datetime at which to retrieve the access metadata rule. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
QuoteAccessMetadataRule

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ GetQuotesAccessMetadataRuleWithHttpInfo()

ApiResponse<QuoteAccessMetadataRule> Lusid.Sdk.Api.IQuotesApiSync.GetQuotesAccessMetadataRuleWithHttpInfo ( string  scope,
string?  provider = default(string?),
string?  priceSource = default(string?),
string?  instrumentIdType = default(string?),
string?  instrumentId = default(string?),
string?  quoteType = default(string?),
string?  field = default(string?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule

Get a specific quote access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
providerThe Provider of the rule (optional)
priceSourceThe PriceSource of the rule (optional)
instrumentIdTypeThe InstrumentIdType of the rule (optional)
instrumentIdThe InstrumentId of the rule (optional)
quoteTypeThe QuoteType of the rule (optional)
fieldThe Field of the rule (optional)
effectiveAtThe effective date of the rule (optional)
asAtThe asAt datetime at which to retrieve the access metadata rule. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of QuoteAccessMetadataRule

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ GetQuotesWithHttpInfo()

ApiResponse<GetQuotesResponse> Lusid.Sdk.Api.IQuotesApiSync.GetQuotesWithHttpInfo ( string  scope,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  maxAge = default(string?),
Dictionary< string, QuoteSeriesId >?  requestBody = default(Dictionary< string, QuoteSeriesId >?),
int  operationIndex = 0 
)

[EARLY ACCESS] GetQuotes: Get quotes

Get one or more quotes from a single scope. Each quote can be identified by its time invariant quote series id. For each quote series id LUSID will return the most recent quote with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for a quote from the specified effective datetime. LUSID will return the most recent quote within this window. In the request each quote series id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return three collections. One, the successfully retrieved quotes. Two, those that had a valid quote series id but could not be found. Three, those that failed because LUSID could not construct a valid quote series id from the request. For the quotes that failed or could not be found a reason will be provided explaining why the quote could not be retrieved. It is important to always check the failed and not found sets for any unsuccessful results. The maximum number of quotes that this method can get per request is 2,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the quotes to retrieve.
effectiveAtThe effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote if not specified. (optional)
maxAgeThe duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime or cut label to generate a effective datetime window inside which a quote must exist to be retrieved. (optional)
requestBodyThe time invariant quote series ids of the quotes to retrieve. These need to be keyed by a unique correlation id allowing the retrieved quote to be identified in the response. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of GetQuotesResponse

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ ListQuotes()

ResourceListOfQuote Lusid.Sdk.Api.IQuotesApiSync.ListQuotes ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[DEPRECATED] ListQuotes: List quotes

List all the quotes from a single scope at the specified date/time Please use M:Finbourne.WebApi.Controllers.QuotesController.ListQuotesForScope(System.String,System.Nullable{System.DateTimeOffset},System.String,System.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the quotes to list.
asAtThe asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional)
pageThe pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfQuote

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ ListQuotesAccessMetadataRules()

ResourceListOfQuoteAccessMetadataRule Lusid.Sdk.Api.IQuotesApiSync.ListQuotesAccessMetadataRules ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope

Get all the quote access metadata rules in the specified scope

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
asAtThe asAt datetime at which to retrieve the access metadata rule. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfQuoteAccessMetadataRule

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ ListQuotesAccessMetadataRulesWithHttpInfo()

ApiResponse<ResourceListOfQuoteAccessMetadataRule> Lusid.Sdk.Api.IQuotesApiSync.ListQuotesAccessMetadataRulesWithHttpInfo ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope

Get all the quote access metadata rules in the specified scope

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
asAtThe asAt datetime at which to retrieve the access metadata rule. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfQuoteAccessMetadataRule

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ ListQuotesForScope()

ResourceListOfQuote Lusid.Sdk.Api.IQuotesApiSync.ListQuotesForScope ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

ListQuotesForScope: List quotes for scope

List all the quotes from a single scope at the specified date/time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the quotes to list.
asAtThe asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional)
pageThe pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfQuote

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ ListQuotesForScopeWithHttpInfo()

ApiResponse<ResourceListOfQuote> Lusid.Sdk.Api.IQuotesApiSync.ListQuotesForScopeWithHttpInfo ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

ListQuotesForScope: List quotes for scope

List all the quotes from a single scope at the specified date/time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the quotes to list.
asAtThe asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional)
pageThe pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfQuote

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ ListQuotesWithHttpInfo()

ApiResponse<ResourceListOfQuote> Lusid.Sdk.Api.IQuotesApiSync.ListQuotesWithHttpInfo ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[DEPRECATED] ListQuotes: List quotes

List all the quotes from a single scope at the specified date/time Please use M:Finbourne.WebApi.Controllers.QuotesController.ListQuotesForScope(System.String,System.Nullable{System.DateTimeOffset},System.String,System.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the quotes to list.
asAtThe asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional)
pageThe pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfQuote

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ UpsertQuoteAccessMetadataRule()

QuoteAccessMetadataRule Lusid.Sdk.Api.IQuotesApiSync.UpsertQuoteAccessMetadataRule ( string  scope,
UpsertQuoteAccessMetadataRuleRequest  upsertQuoteAccessMetadataRuleRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule. This creates or updates the data in LUSID.

Update or insert one Quote Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Quote Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a key can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the Quote Access Metadata Rule.
upsertQuoteAccessMetadataRuleRequestThe Quote Access Metadata Rule to update or insert
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
QuoteAccessMetadataRule

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ UpsertQuoteAccessMetadataRuleWithHttpInfo()

ApiResponse<QuoteAccessMetadataRule> Lusid.Sdk.Api.IQuotesApiSync.UpsertQuoteAccessMetadataRuleWithHttpInfo ( string  scope,
UpsertQuoteAccessMetadataRuleRequest  upsertQuoteAccessMetadataRuleRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)

[EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule. This creates or updates the data in LUSID.

Update or insert one Quote Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Quote Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a key can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the Quote Access Metadata Rule.
upsertQuoteAccessMetadataRuleRequestThe Quote Access Metadata Rule to update or insert
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of QuoteAccessMetadataRule

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ UpsertQuotes()

UpsertQuotesResponse Lusid.Sdk.Api.IQuotesApiSync.UpsertQuotes ( string  scope,
Dictionary< string, UpsertQuoteRequest >?  requestBody = default(Dictionary< string, UpsertQuoteRequest >?),
int  operationIndex = 0 
)

UpsertQuotes: Upsert quotes

Update or insert one or more quotes in a single scope. A quote will be updated if it already exists and inserted if it does not. In the request each quote must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully updated or inserted quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. The maximum number of quotes that this method can upsert per request is 2,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the quotes.
requestBodyThe quotes to update or insert keyed by a unique correlation id. (optional)
operationIndexIndex associated with the operation.
Returns
UpsertQuotesResponse

Implemented in Lusid.Sdk.Api.QuotesApi.

◆ UpsertQuotesWithHttpInfo()

ApiResponse<UpsertQuotesResponse> Lusid.Sdk.Api.IQuotesApiSync.UpsertQuotesWithHttpInfo ( string  scope,
Dictionary< string, UpsertQuoteRequest >?  requestBody = default(Dictionary< string, UpsertQuoteRequest >?),
int  operationIndex = 0 
)

UpsertQuotes: Upsert quotes

Update or insert one or more quotes in a single scope. A quote will be updated if it already exists and inserted if it does not. In the request each quote must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully updated or inserted quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. The maximum number of quotes that this method can upsert per request is 2,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the quotes.
requestBodyThe quotes to update or insert keyed by a unique correlation id. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of UpsertQuotesResponse

Implemented in Lusid.Sdk.Api.QuotesApi.


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