RetrieveExchangeRateRequest RetrieveExchangeRateRequest RetrieveExchangeRateRequest RetrieveExchangeRateRequest Class

Definition

Contains the data that is needed to retrieve the exchange rate.

For the Web API use the RetrieveExchangeRate Function.

public ref class RetrieveExchangeRateRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveExchangeRateRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RetrieveExchangeRateRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveExchangeRateRequest
Inherits OrganizationRequest
Inheritance
RetrieveExchangeRateRequestRetrieveExchangeRateRequestRetrieveExchangeRateRequestRetrieveExchangeRateRequest
Attributes

Examples


// Connect to the Organization service. 
// The using statement assures that the service proxy will be properly disposed.

using (var svc = new CrmServiceClient(connectionstring))
{
   CreateRequiredRecords();
var request = new RetrieveExchangeRateRequest()
    {
        TransactionCurrencyId = _currency.Id
    };

    var response = 
        (RetrieveExchangeRateResponse)svc.Execute(request);
    Console.WriteLine("  Retrieved exchange rate for created currency");

// get the base currency for the current org
    var baseCurrencyName = (from currency in _context.TransactionCurrencySet
         join org in _context.OrganizationSet 
         on currency.Id equals org.BaseCurrencyId.Id
         where org.Name == currentOrganizatoinUniqueName
         select currency.CurrencyName).FirstOrDefault();
    Console.WriteLine("  This organization's base currency is {0}",
        baseCurrencyName);
Console.WriteLine(" The conversion from {0} -> {1} is {2}", _currency.CurrencyName,baseCurrencyName,response.ExchangeRate);
DeleteRequiredRecords(promptforDelete);
}

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

BusinessManagement#TransactionCurrencyExchangeRate1 BusinessManagementVB#TransactionCurrencyExchangeRate1

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the RetrieveExchangeRateResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the TransactionCurrency entity and access rights to the specified record in the TransactionCurrencyId property.

For a complete list of the required privileges, see RetrieveExchangeRate message privileges.

Constructors

RetrieveExchangeRateRequest() RetrieveExchangeRateRequest() RetrieveExchangeRateRequest() RetrieveExchangeRateRequest()

Initializes a new instance of the RetrieveExchangeRateRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
TransactionCurrencyId TransactionCurrencyId TransactionCurrencyId TransactionCurrencyId

Gets or sets the ID of the currency. Required.

Applies to

See also