Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
| QuotesApi () | |
| Initializes a new instance of the QuotesApi class. More... | |
| QuotesApi (String basePath) | |
| Initializes a new instance of the QuotesApi class. More... | |
| QuotesApi (Lusid.Sdk.Client.Configuration configuration) | |
| Initializes a new instance of the QuotesApi class using Configuration object More... | |
| QuotesApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
| Initializes a new instance of the QuotesApi class using a Configuration object and client instance. More... | |
| String | GetBasePath () |
| Gets the base path of the API client. More... | |
| AnnulQuotesResponse | DeleteQuotes (string scope, Dictionary< string, QuoteId > requestBody=default(Dictionary< string, QuoteId >)) |
| [EARLY ACCESS] 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. More... | |
| Lusid.Sdk.Client.ApiResponse< AnnulQuotesResponse > | DeleteQuotesWithHttpInfo (string scope, Dictionary< string, QuoteId > requestBody=default(Dictionary< string, QuoteId >)) |
| [EARLY ACCESS] 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. More... | |
| async System.Threading.Tasks.Task< AnnulQuotesResponse > | DeleteQuotesAsync (string scope, Dictionary< string, QuoteId > requestBody=default(Dictionary< string, QuoteId >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] 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. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AnnulQuotesResponse > > | DeleteQuotesWithHttpInfoAsync (string scope, Dictionary< string, QuoteId > requestBody=default(Dictionary< string, QuoteId >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] 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. 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 >)) |
| [EARLY ACCESS] 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. More... | |
| Lusid.Sdk.Client.ApiResponse< GetQuotesResponse > | GetQuotesWithHttpInfo (string scope, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string maxAge=default(string), Dictionary< string, QuoteSeriesId > requestBody=default(Dictionary< string, QuoteSeriesId >)) |
| [EARLY ACCESS] 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. More... | |
| async System.Threading.Tasks.Task< GetQuotesResponse > | GetQuotesAsync (string scope, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string maxAge=default(string), Dictionary< string, QuoteSeriesId > requestBody=default(Dictionary< string, QuoteSeriesId >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] 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. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< GetQuotesResponse > > | GetQuotesWithHttpInfoAsync (string scope, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string maxAge=default(string), Dictionary< string, QuoteSeriesId > requestBody=default(Dictionary< string, QuoteSeriesId >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] 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. More... | |
| ResourceListOfQuote | ListQuotes (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string)) |
| [DEPRECATED] 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.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope More... | |
| Lusid.Sdk.Client.ApiResponse< ResourceListOfQuote > | ListQuotesWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string)) |
| [DEPRECATED] 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.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope More... | |
| async System.Threading.Tasks.Task< ResourceListOfQuote > | ListQuotesAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [DEPRECATED] 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.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfQuote > > | ListQuotesWithHttpInfoAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [DEPRECATED] 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.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope More... | |
| ResourceListOfQuote | ListQuotesForScope (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string)) |
| [EARLY ACCESS] List quotes for scope List all the quotes from a single scope at the specified date/time More... | |
| Lusid.Sdk.Client.ApiResponse< ResourceListOfQuote > | ListQuotesForScopeWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string)) |
| [EARLY ACCESS] List quotes for scope List all the quotes from a single scope at the specified date/time More... | |
| async System.Threading.Tasks.Task< ResourceListOfQuote > | ListQuotesForScopeAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] List quotes for scope List all the quotes from a single scope at the specified date/time More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfQuote > > | ListQuotesForScopeWithHttpInfoAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? start=default(int?), int? limit=default(int?), string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] List quotes for scope List all the quotes from a single scope at the specified date/time More... | |
| UpsertQuotesResponse | UpsertQuotes (string scope, Dictionary< string, UpsertQuoteRequest > requestBody=default(Dictionary< string, UpsertQuoteRequest >)) |
| [EARLY ACCESS] 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. More... | |
| Lusid.Sdk.Client.ApiResponse< UpsertQuotesResponse > | UpsertQuotesWithHttpInfo (string scope, Dictionary< string, UpsertQuoteRequest > requestBody=default(Dictionary< string, UpsertQuoteRequest >)) |
| [EARLY ACCESS] 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. More... | |
| async System.Threading.Tasks.Task< UpsertQuotesResponse > | UpsertQuotesAsync (string scope, Dictionary< string, UpsertQuoteRequest > requestBody=default(Dictionary< string, UpsertQuoteRequest >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] 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. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertQuotesResponse > > | UpsertQuotesWithHttpInfoAsync (string scope, Dictionary< string, UpsertQuoteRequest > requestBody=default(Dictionary< string, UpsertQuoteRequest >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] 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. More... | |
Properties | |
| Lusid.Sdk.Client.IAsynchronousClient | AsynchronousClient [get, set] |
| The client for accessing this underlying API asynchronously. More... | |
| Lusid.Sdk.Client.ISynchronousClient | Client [get, set] |
| The client for accessing this underlying API synchronously. More... | |
| Lusid.Sdk.Client.IReadableConfiguration | Configuration [get, set] |
| Gets or sets the configuration object More... | |
| Lusid.Sdk.Client.ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
 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
Constructor & Destructor Documentation
◆ QuotesApi() [1/4]
|
inline |
Initializes a new instance of the QuotesApi class.
- Returns
◆ QuotesApi() [2/4]
|
inline |
Initializes a new instance of the QuotesApi class.
- Returns
◆ QuotesApi() [3/4]
|
inline |
Initializes a new instance of the QuotesApi class using Configuration object
- Parameters
-
configuration An instance of Configuration
- Returns
◆ QuotesApi() [4/4]
|
inline |
Initializes a new instance of the QuotesApi class using a Configuration object and client instance.
- Parameters
-
client The client interface for synchronous API access. asyncClient The client interface for asynchronous API access. configuration The configuration object.
Member Function Documentation
◆ DeleteQuotes()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to delete. requestBody The quotes to delete keyed by a unique correlation id. (optional)
- Returns
- AnnulQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ DeleteQuotesAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to delete. requestBody The quotes to delete keyed by a unique correlation id. (optional) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of AnnulQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ DeleteQuotesWithHttpInfo()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to delete. requestBody The quotes to delete keyed by a unique correlation id. (optional)
- Returns
- ApiResponse of AnnulQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ DeleteQuotesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to delete. requestBody The quotes to delete keyed by a unique correlation id. (optional) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (AnnulQuotesResponse)
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ GetBasePath()
|
inline |
◆ GetQuotes()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to retrieve. effectiveAt The effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote if not specified. (optional) maxAge The 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) requestBody The 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)
- Returns
- GetQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ GetQuotesAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to retrieve. effectiveAt The effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote if not specified. (optional) maxAge The 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) requestBody The 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) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of GetQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ GetQuotesWithHttpInfo()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to retrieve. effectiveAt The effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote if not specified. (optional) maxAge The 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) requestBody The 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)
- Returns
- ApiResponse of GetQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ GetQuotesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to retrieve. effectiveAt The effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote if not specified. (optional) maxAge The 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) requestBody The 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) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (GetQuotesResponse)
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ ListQuotes()
|
inline |
[DEPRECATED] 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.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to list. asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional) page The 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. Also, if set, a start value cannot be provided. (optional) start When paginating, skip this number of results. (optional) limit When paginating, limit the number of returned results to this many. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
- Returns
- ResourceListOfQuote
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ ListQuotesAsync()
|
inline |
[DEPRECATED] 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.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to list. asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional) page The 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. Also, if set, a start value cannot be provided. (optional) start When paginating, skip this number of results. (optional) limit When paginating, limit the number of returned results to this many. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfQuote
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ ListQuotesForScope()
|
inline |
[EARLY ACCESS] List quotes for scope List all the quotes from a single scope at the specified date/time
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to list. asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional) page The 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. Also, if set, a start value cannot be provided. (optional) start When paginating, skip this number of results. (optional) limit When paginating, limit the number of returned results to this many. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
- Returns
- ResourceListOfQuote
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ ListQuotesForScopeAsync()
|
inline |
[EARLY ACCESS] List quotes for scope List all the quotes from a single scope at the specified date/time
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to list. asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional) page The 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. Also, if set, a start value cannot be provided. (optional) start When paginating, skip this number of results. (optional) limit When paginating, limit the number of returned results to this many. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfQuote
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ ListQuotesForScopeWithHttpInfo()
|
inline |
[EARLY ACCESS] List quotes for scope List all the quotes from a single scope at the specified date/time
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to list. asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional) page The 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. Also, if set, a start value cannot be provided. (optional) start When paginating, skip this number of results. (optional) limit When paginating, limit the number of returned results to this many. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
- Returns
- ApiResponse of ResourceListOfQuote
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ ListQuotesForScopeWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] List quotes for scope List all the quotes from a single scope at the specified date/time
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to list. asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional) page The 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. Also, if set, a start value cannot be provided. (optional) start When paginating, skip this number of results. (optional) limit When paginating, limit the number of returned results to this many. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfQuote)
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ ListQuotesWithHttpInfo()
|
inline |
[DEPRECATED] 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.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to list. asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional) page The 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. Also, if set, a start value cannot be provided. (optional) start When paginating, skip this number of results. (optional) limit When paginating, limit the number of returned results to this many. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
- Returns
- ApiResponse of ResourceListOfQuote
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ ListQuotesWithHttpInfoAsync()
|
inline |
[DEPRECATED] 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.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the quotes to list. asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. (optional) page The 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. Also, if set, a start value cannot be provided. (optional) start When paginating, skip this number of results. (optional) limit When paginating, limit the number of returned results to this many. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfQuote)
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ UpsertQuotes()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope to use when updating or inserting the quotes. requestBody The quotes to update or insert keyed by a unique correlation id. (optional)
- Returns
- UpsertQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ UpsertQuotesAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope to use when updating or inserting the quotes. requestBody The quotes to update or insert keyed by a unique correlation id. (optional) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of UpsertQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiAsync.
◆ UpsertQuotesWithHttpInfo()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope to use when updating or inserting the quotes. requestBody The quotes to update or insert keyed by a unique correlation id. (optional)
- Returns
- ApiResponse of UpsertQuotesResponse
Implements Lusid.Sdk.Api.IQuotesApiSync.
◆ UpsertQuotesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope to use when updating or inserting the quotes. requestBody The quotes to update or insert keyed by a unique correlation id. (optional) cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (UpsertQuotesResponse)
Implements Lusid.Sdk.Api.IQuotesApiAsync.
Property Documentation
◆ AsynchronousClient
|
getset |
The client for accessing this underlying API asynchronously.
◆ Client
|
getset |
The client for accessing this underlying API synchronously.
◆ Configuration
|
getset |
Gets or sets the configuration object
An instance of the Configuration
◆ ExceptionFactory
|
getset |
Provides a factory method hook for the creation of exceptions.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/stable/sdk/Lusid.Sdk/Api/QuotesApi.cs
