RetrieveExchangeRateRequest Class
Applies To: Microsoft Dynamics CRM 2013, 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)
Syntax
'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RetrieveExchangeRateRequest
Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveExchangeRateRequest : OrganizationRequest
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 = GetCurrentOrganizationName(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).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);
}
' Connect to the Organization service.
' The using statement assures that the service proxy will be properly disposed.
_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig)
Using _serviceProxy
' using the service context makes retrieving entities easier
_context = New ServiceContext(_serviceProxy)
Using _context
' This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes()
Dim currentOrganizatoinUniqueName As String = GetCurrentOrganizationUniqueName(serverConfig)
CreateRequiredRecords()
Dim request As New RetrieveExchangeRateRequest() With
{
.TransactionCurrencyId = _currency.Id
}
Dim response As RetrieveExchangeRateResponse =
CType(_serviceProxy.Execute(request),
RetrieveExchangeRateResponse)
Console.WriteLine(" Retrieved exchange rate for created currency")
' get the base currency for the current org
Dim baseCurrencyName = ( _
From currency In _context.TransactionCurrencySet _
Join org In _context.OrganizationSet On currency.Id Equals org.BaseCurrencyId.Id _
Where org.Name.Equals(serverConfig.OrganizationName) _
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)
End Using
End Using
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
Development Platforms
Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)
Target Platforms
Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),
Change History
See Also
Reference
RetrieveExchangeRateRequest Members
Microsoft.Crm.Sdk.Messages Namespace
RetrieveExchangeRateResponse
Other Resources
RetrieveExchangeRate Privileges
TransactionCurrency (Currency) Entity
Sample: Retrieve Currency Exchange Rate
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.