CRMLicense.AddDeploymentLicense Method

The AddDeploymentLicense method adds the specified software license to a deployment. To perform this action, the caller must be a domain administrator when the first license is added to a deployment.

Syntax

[Visual Basic .NET]
Public Sub AddDeploymentLicense(
  ByVal Caller As CUserAuth,
  ByVal OrganizationId As String,
  ByVal LicenseType As String,
  ByVal LicenseKey As String
)
[C#]
public void AddDeploymentLicense(
  CUserAuth  Caller,
  string  OrganizationId,
  string  LicenseType,
  string  LicenseKey
);
[C++]
public: void AddDeploymentLicense(
  CUserAuth*  Caller,
  String*  OrganizationId,
  String*  LicenseType,
  String*  LicenseKey
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteLicense privilege and access rights on the object to be modified. See CUserAuth.

OrganizationId

Specifies the ID of the organization.

LicenseType

Specifies the ID of the license type.

LicenseKey

Specifies the ID of the license key.

Return Value

No return value.

Remarks

If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.

All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}

Example

[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "http://" + strServer + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMLicense proxy object
Microsoft.Crm.Platform.Proxy.CRMLicense license = new Microsoft.Crm.Platform.Proxy.CRMLicense();
license.Credentials = System.Net.CredentialCache.DefaultCredentials;
license.Url = strDir + "CRMLicense.srf";

string strErrorMsg = "";

// Valid license key
string LicenseKey = "{QFL6W8JZ-TU8U-0NU6-1JKH-807F897C5027}";

// Valid organization ID
string strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}";

// Microsoft CRM Suite Professional
string LicenseType = "{59F6D48E-F7E8-46F3-806C-3CA992D21915}";

try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
   
   // Call AddDeploymentLicense
   license.AddDeploymentLicense(userAuth, strOrgId, LicenseType, LicenseKey);
}
catch (System.Web.Services.Protocols.SoapException err)
{
   // Process the platform error here
   strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
   // Process other errors here
   strErrorMsg = ("ErrorMessage: " + err.Message );
}

Requirements

Namespace: Microsoft.Crm.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.