CRMArticleTemplate.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an existing article template and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal ArticleTemplateId As String,
ByVal ArticleTemplateXML As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string ArticleTemplateId,
string ArticleTemplateXML
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* ArticleTemplateId,
String* ArticleTemplateXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvWriteArticleTemplate and prvReadArticleTemplate privileges to perform this action. See CUserAuth.
ArticleTemplateId
Specifies the ID of the article template to update.
ArticleTemplateXML
Specifies an XML string representing the article template. The XML schema is described by kbarticletemplate.xsd.
Return Value
Returns a String type that specifies the XML data representing the new article template. The XML schema is described by kbarticletemplate.xsd.
Remarks
Create a value for the structure field that is meaningful for your application. Note that these article templates do not work with the Microsoft CRM application, which uses a proprietary article template format.
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 XML string for the article template
string strXml = "<kbarticletemplate>";
strXml += "<title>A new title</title>";
strXml += "</kbarticletemplate>";
// Update the article template, and then retrieve it
string strResultsXml = articletemplate.UpdateAndRetrieve(userAuth, strArticleTemplateId, strXml);
}
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