CRMSubject.RetrieveRootNodes Method
The RetrieveRootNodes method retrieves all root nodes for the specified organization. Root nodes are subjects whose parent subject is NULL.
Syntax
[Visual Basic .NET]
Public Function RetrieveRootNodes(
ByVal Caller As CUserAuth,
ByVal OrganizationId As String,
ByVal Mask As UInt32,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveRootNodes(
CUserAuth Caller,
string OrganizationId,
uint Mask,
string ColumnSetXML
);
[C++]
public: String* RetrieveRootNodes(
CUserAuth* Caller,
String* OrganizationId,
unsigned long Mask,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadSubject privilege to perform this action. See CUserAuth.
OrganizationId
Specifies the ID of the organization.
Mask
Specifies the feature mask (Incident, KBArticle, ...).
ColumnSetXML
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in subject.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the set of subjects requested. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by subject.xsd.
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 = "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";
// CRMSubject proxy object
Microsoft.CRM.Proxy.CRMSubject subject = new Microsoft.CRM.Proxy.CRMSubject();
subject.Credentials = System.Net.CredentialCache.DefaultCredentials;
subject.Url = strDir + "CRMSubject.srf";
string strErrorMsg;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strOrgId = "{E4735CBC-A539-4B8C-B848-0C3C94E19BA6}";
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "</columnset>";
// Retrieve the root nodes
string strResultsXml = subject.RetrieveRootNodes(userAuth, strOrgId, 1, strColumnSetXml);
}
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