CRMArticle.RetrieveByState Method
The RetrieveByState method retrieves all the articles with the specified state for the specified organization.
Syntax
[Visual Basic .NET]
Public Function RetrieveByState(
ByVal Caller As CUserAuth,
ByVal OrganizationId As String,
ByVal State As UInt32,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveByState(
CUserAuth Caller,
string OrganizationId,
uint State,
string ColumnSetXML
);
[C++]
public: String* RetrieveByState(
CUserAuth* Caller,
String* OrganizationId,
unsigned long State,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadArticle privilege to perform this action. See CUserAuth.
OrganizationId
Specifies the ID of the organization.
State
Specifies the state of article to be retrieved. See KBARTICLE_STATE.
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 kbarticle.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the articles retrieved. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by kbarticle.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";
// CRMArticle proxy object
Microsoft.CRM.Proxy.CRMArticle article = new Microsoft.CRM.Proxy.CRMArticle ();
article.Credentials = System.Net.CredentialCache.DefaultCredentials;
article.Url = strDir + "CRMArticle.srf";
string strErrorMsg;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Valid Organization ID
string strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}";
uint state = Microsoft.CRM.Flags.KBAS_PUBLISHED;
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "</columnset>";
// Retrieve the articles
string strArticlesXml = article.RetrieveByState (userAuth, strOrgId, state, 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