This topic has not yet been rated - Rate this topic

RetrieveExchangeRateRequest Class

[Applies to: Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online]

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

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

'Usage

Syntax

C++

[DataContractAttribute(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveExchangeRateRequest : OrganizationRequest

JScript

Example

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.


// Connect to the Organization service. 
// The using statement assures that the service proxy will be properly disposed.
using (_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig))
// using the service context makes retrieving entities easier
using (_context = new ServiceContext(_serviceProxy))
{
    // This statement is required to enable early-bound type support.
    _serviceProxy.EnableProxyTypes();

    String currentOrganizatoinUniqueName = GetCurrentOrganizationUniqueName(serverConfig);

    CreateRequiredRecords();

    RetrieveExchangeRateRequest request = new RetrieveExchangeRateRequest()
    {
        TransactionCurrencyId = _currency.Id
    };
    RetrieveExchangeRateResponse response = 
        (RetrieveExchangeRateResponse)_serviceProxy.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).First();
    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);
}

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 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 Privileges.

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RetrieveExchangeRateRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms