CRMProcess.GetEntityByName Method

  • Article

The GetEntityByName method retrieves the XML data for an entity by its name. See Remarks.

Syntax

[Visual Basic .NET]
Public Function GetEntityByName(
  ByVal Caller As CUserAuth,
  ByVal EntityName As String,
  ByVal Mapping As Integer
) As String
[C#]
public string GetEntityByName(
  CUserAuth  Caller,
  string  EntityName,
  int  Mapping
);
[C++]
public: String* GetEntityByName(
  CUserAuth*  Caller,
  String*  EntityName,
  long  Mapping
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadWorkflowProcess privilege to perform this action. See CUserAuth.

EntityName

Specifies the name of the entity that is to be retrieved. For the list of entity names see the XML schema name column in ObjectTypes.

Mapping

Specifies the mapping. This parameter must be set to 1.

Return Value

Returns a String type that specifies the XML data containing the entity.

Remarks

Every entity and field in Microsoft CRM is specified by a GUID. The entity XML data that is returned by this method contains the GUID for both the entity (entityid) and each of its fields (attributeid). You can determine the attributeid for a particular field from this XML data for the entity. The attributeid is a required field for WFPM_PROPERTY, WFPM_PROCESS, and WFPM_ACTION in the WORKFLOW_PARAMETER_TYPE class.

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 = "https://" + strServer + "/" + virtualDirectory + "/";

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

// CRMProcess proxy object
Microsoft.CRM.Proxy.CRMProcess  process = new Microsoft.CRM.Proxy.CRMProcess();
process.Credentials = System.Net.CredentialCache.DefaultCredentials;
process.Url = strDir + "CRMProcess.srf";

string strErrorMsg;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Get the entity
   string strEntityXml = process.GetEntityByName(userAuth, "lead", 1);
}
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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.