OrganizationServiceProxy.SdkClientVersion Property

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Gets or sets the version of the client.

Namespace: Microsoft.Xrm.Sdk.Client
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

'Declaration
Public Property SdkClientVersion As String

public string SdkClientVersion { get; set; }

Property Value

Type: String.
The version of the client.

Remarks

.NET clients using the current assemblies will pass the value ‘6.0.0.0’ or higher to indicate the client version. .NET clients using assemblies for earlier versions will not pass a value. This difference allows for messages that retrieve attribute metadata for the appropriate version. This applies to the following messages:

Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online introduced a new attribute type: ImageAttributeMetadata. .NET assemblies for previous versions do not recognize this type and an error occurs attempting to deserialize them. When attribute metadata is retrieved, if the assembly does not pass a SdkClientVersion value ImageAttributeMetadata attributes will not be returned.

Clients that do not use .NET assemblies need to include SdkClientVersion with a value of ‘6.0.0.0’ or higher in order to receive ImageAttributeMetadata attributes.

For JavaScript, this value can be added to the SOAP header as shown in the following code snippet taken from the SDK.MetaData.js library described in Sample: Retrieve Entity Metadata Using JavaScript.

<soapenv:Header><a:SdkClientVersion xmlns:a=\"https://schemas.microsoft.com/xrm/2011/Contracts\">6.0</a:SdkClientVersion></soapenv:Header>

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

OrganizationServiceProxy Class
OrganizationServiceProxy Members
Microsoft.Xrm.Sdk.Client Namespace

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.