CRMArticleTemplate.Retrieve Method
The Retrieve method retrieves an existing article template.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal ArticleTemplateId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string ArticleTemplateId,
string ColumnSetXML
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* ArticleTemplateId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadArticleTemplate privilege to perform this action. See CUserAuth.
ArticleTemplateId
Specifies the ID of the article template.
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 kbarticletemplate.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the article template. The fields that are returned for each team depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by kbarticletemplate.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";
// CRMArticleTemplate proxy object
Microsoft.CRM.Proxy.CRMArticleTemplate articletemplate = new Microsoft.CRM.Proxy.CRMArticleTemplate ();
articletemplate.Credentials = System.Net.CredentialCache.DefaultCredentials;
articletemplate.Url = strDir + "CRMArticleTemplate.srf";
string strErrorMsg;
string strArticleTemplateId = "{72D46F0C-3855-4CA2-96E9-498E9BA08665}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "</columnset>";
// Retrieve the article template
string strArticleTemplateXml = articletemplate.Retrieve(userAuth, strArticleTemplateId, 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