CRMAnswer.SearchByBody Method
The SearchByBody method executes a full-text search by body.
Syntax
[Visual Basic .NET]
Public Function SearchByBody(
ByVal Caller As CUserAuth,
ByVal SearchText As String,
ByVal SubjectId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string SearchByBody(
CUserAuth Caller,
string SearchText,
string SubjectId,
string ColumnSetXML
);
[C++]
public: String* SearchByBody(
CUserAuth* Caller,
String* SearchText,
String* SubjectId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. See CUserAuth.
SearchText
Specifies the text to search for.
SubjectId
Specifies the ID of the subject.
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 documentindex.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the answers requested. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by documentindex.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";
// CRMAnswer proxy object
Microsoft.CRM.Proxy.CRMAnswer answer = new Microsoft.CRM.Proxy.CRMAnswer ();
answer.Credentials = System.Net.CredentialCache.DefaultCredentials;
answer.Url = strDir + "CRMAnswer.srf";
string strErrorMsg;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// A valid subject ID
string strSubjectId = "{E4735CBC-A539-4B8C-B848-0C3C94E19BA6}";
string strSearch = "title";
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>subjectid</column>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "</columnset>";
// Retrieve the answer
string strAnswerXml = answer.SearchByBody (userAuth, strSearch, strSubjectId, 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