CRMArticle.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an existing article and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal ArticleId As String,
ByVal ArticleXML As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string ArticleId,
string ArticleXML
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* ArticleId,
String* ArticleXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteArticle and prvReadArticle privileges and access rights on the object to be modified. See CUserAuth.
ArticleId
Specifies the ID of the article.
ArticleXML
Specifies an XML string representing the article. The XML schema is described by kbarticle.xsd.
Return Value
Returns a String type that specifies the XML data representing the updated article. The XML schema is described by kbarticle.xsd.
Remarks
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMArticle proxy object
Microsoft.Crm.Platform.Proxy.CRMArticle article = new Microsoft.Crm.Platform.Proxy.CRMArticle ();
article.Credentials = System.Net.CredentialCache.DefaultCredentials;
article.Url = strDir + "CRMArticle.srf";
string strErrorMsg;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strArticleId = "{70769894-638F-41F2-A692-E2BC7ED23557}";
// Set up XML string to update the article
string strXml = "<kbarticle>";
strXml += "<title>A new title</title>";
strXml += "</kbarticle>";
// Update and then retrieve the article
string strArticleXml = article.UpdateAndRetrieve(userAuth, strArticleId, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also