CRMAnswer.RetrieveByNumber Method

The RetrieveByNumber method retrieves an answer by the number specified. Only published answers are retrieved.

Syntax

[Visual Basic .NET]
Public Function RetrieveByNumber(
  ByVal Caller As CUserAuth,
  ByVal OrganizationId As String,
  ByVal AnswerNumber As String,
  ByVal ColumnSetXML As String
) As String

[C#]
public string RetrieveByNumber(
  CUserAuth  Caller,
  string  OrganizationId,
  string  AnswerNumber,
  string  ColumnSetXML
);

[C++]
public: String* RetrieveByNumber(
  CUserAuth*  Caller,
  String*  OrganizationId,
  String*  AnswerNumber,
  String*  ColumnSetXML
);

Parameters

Caller

Specifies the identity of the caller. See CUserAuth.

OrganizationId

Specifies the ID of the organization.

AnswerNumber

Specifies the number of the answer.

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 found. 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 = "http://" + 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;

// A valid organization ID
string strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}";
string num = "1";

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

   // 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.RetrieveByNumber(userAuth, strOrgId, num, 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

© 2003 Microsoft Corporation. All rights reserved.