Home > Blogs > Eric Shupps | The SharePoint Cowboy > Posts > Trapping XML Errors Using SharePoint Web Services
 
Eric Shupps eshupps The SharePoint Cowboy is the founder and President of BinaryWave, a leading provider of operational intelligence solutions for Microsoft SharePoint. Eric Shupps eshupps The SharePoint Cowboy has worked with SharePoint Products and Technologies since 2001 as a consultant, administrator, architect, developer and trainer. he is an advisory committee member of the Dallas/Ft. Worth SharePoint Community group and participating member of user groups throughout the United Kingdom. Eric Shupps eshupps The SharePoint Cowboy has authored numerous articles on SharePoint, speaks at user group meetings and conferences around the world, and publishes a popular SharePoint blog at http://www.sharepointcowboy.com. Presentations by Eric Shupps eshupps The SharePoint Cowboy Webinar - Migrating Legacy On Premise Solutions to SharePoint Online and Windows Azure featuring Eric Shupps Who are you and what do you want - Working with OAuth in SharePoint 2013 SharePoint is Talking Are You Listening? Eric Shupps SharePoint 2013 Performance Enhancements Taking Advantage of the SharePoint 2013 REST API Eric Shupps on Improving Performance with New Features in SharePoint 2013 SharePoint 2013 New and Improved Migrating Legacy On Premise Solutions to SharePoint Online and Windows Azure Eric Shupps Presents SharePoint 2013 Real World Help Desk App End to End Windows Azure Apps for SharePoint 2013 Eric Shupps Demonstrates Customizing the Visual Studio 2010 SharePoint Deployment Process Introduction to SharePoint Development SharePoint 2010 Unit and Integration Testing with Eric Shupps Building Enterprise Records Management Solutions for SharePoint 2010 Taming Information Chaos in SharePoint 2010 SharePoint 2010 Performance and Capacity Planning Best Practices Building Dynamic Applications with the SharePoint Client Object Model Articles by Eric Shupps eshupps The SharePoint Cowboy Eric Shupps' Ten Steps to Optimize SharePoint Performance Webcasts by Eric Shupps eshupps The SharePoint Cowboy Secrets of SharePoint Part 5: Configuring Microsoft Office SharePoint Server 2007 for Optimal Performance Creating End User SharePoint Solutions for Performance and Scalability SharePoint 2010 Performance Enhancements for Administrators by Eric Shupps Microsoft SharePoint Server 2010 for the ASP.NET Developer Eric Shupps on Following Best Practices and Avoiding Common Errors with Microsoft Office SharePoint Server 2007 Development Eric Shupps - SharePoint Performance and Capacity Planning Essentials Troubleshooting Common Performance Problems in SharePoint 2010 Videos by Eric Shupps eshupps The SharePoint Cowboy Channel 9 Interview with Eric Shupps SharePoint TechTalk with Eric Shupps - Different Views on Social Computing SharePoint Post-Deployment Planning and Management with Eric Shupps SmartTrack for SharePoint Feature Overview SmartTrack for SharePoint Podcasts by Eric Shupps eshupps The SharePoint Cowboy SharePoint Pod Show - Design for Performance (Eric Shupps) SharePoint Pod Show - Test Driven Development with Andrew Woodward and Eric Shupps eshupps The SharePoint Cowboy Run As Radio - Eric Shupps Improves SharePoint Performance
SmartTrack for SharePoint Eric Shupps Eric Alan Shupps eshupps @eshupps SharePoint Cowboy BinaryWave

 
​The SharePoint Cowboy


photo of  Eric Shupps
BinaryWave
611 S. Main St., Suite 400
Grapevine , TX , 76051 USA
Eric Shupps and Eric Alan Shupps with BinaryWave the BinaryWave Inc in BinaryWave Incorporated around SmartTrack beside SharePoint Monitoring through SharePoint alongside SharePoint Monitoring visiting @eshupps via eshupps near SharePoint performance and SharePoint management. The SharePoint cowboy eshupps BinaryWave and more on Operational Intelligence via Eric Alan Shupps SharePoint blog. SharePoint monitoring is a hot topic along with SharePoint Performance Measurement and SharePoint tips and tricks from Eric Shupps for SmartTrack. Another Eric Shupps on Technology and Eric Shupps on SharePoint with a new SharePoint Post from Eric Shupps. New BinaryWave post through BinaryWave Inc. and with another SharePoint blog we get to Eric Alan Shupps Blog about SharePoint development. That's Eric Shupps - BinaryWave or Eric Alan Shupps Fort Worth Grapevine Texas Dallas of BinaryWave talking about BinaryWave Operational Intelligence at the SharePoint Cowboy blog and on twitter as @eshupps. Of course SharePoint Administration is on topic for eshupps and another great post from Eric Shupps regarding BinaryWave SharePoint and SharePoint Maintenance.
June 20
Trapping XML Errors Using SharePoint Web Services

At the DFW SharePoint Community meeting this week we had a lively discussion about SharePoint web services and how difficult they are to debug. This actually has nothing to do with SharePoint per se – all methods that return nothing but strings are hard to debug – but it is a common pain point so I promised to post a code sample of how I deal with it.

A common scenario when working with web services is to pass in a <Method> batch to perform some operation, such as updating items in a list. If all goes well, SharePoint will respond to the invocation of the UpdateListItems method with a block of XML that contains a status code of 0x00000000, meaning that the operation was successful. If it fails, it will return an error status code instead of all zeroes and (sometimes) a description of the error. The problem, of course, is that both return values look the same from a code perspective; no exception is thrown and your method continues on its merry way as if all is good and right in the world. No Try…Catch block will ever trap this kind of error. So what do you do?

The answer is to write a quick routine to parse the return XML values and look for any node that has a return value other than 0x00000000 and either send back your own error text (if the method returns a string, for example), throw a system exception that will trip the Try…Catch block, or both. Keep in mind that each operation that you perform will have a corresponding XML node with a success/fail value; you have to loop through all the return nodes in order to insure that each operation was successful. The following code illustrates building the method for the UpdateListItems operation, passing in the required values, and parsing the return XML to determine if any errors are present. In this example I'm showing how to use both a return value and throw an exception; use either or both according to your needs.

 

try

{

 

// Create a new XML document to contain our operation nodes

XmlDocument xmlUpdate = new XmlDocument();

 

// Create the required nodes and insert the Update XML

XmlNode ndBatch = xmlUpdate.CreateNode(XmlNodeType.Element, "Batch", "");

ndBatch.InnerXml = "<Method ID='1' Cmd='" + sMode + "'>" + sUpdateFields + "</Method>";

 

// Instruct SharePoint not to break after the first error is encountered so we can get back a complete list of failed operations

XmlAttribute xmlAttribErr = (XmlAttribute)xmlUpdate.CreateNode(XmlNodeType.Attribute, "OnError", "");

xmlAttribErr.Value = "Continue";

ndBatch.Attributes.Append(xmlAttribErr);

 

// Pass our XML to the UpdateListItems method along with the target List name

XmlNode xReturn = listsvc.UpdateListItems(sListName, ndBatch);

 

// Instantiate a new XML document object to hold the return value(s)

XmlDocument xmlResult = new XmlDocument();

xmlResult.LoadXml(xReturn.OuterXml);

 

// SharePoint XML always uses a fixed namespace; you'll need your own NamespaceManager object to parse the return values

XmlNamespaceManager nsMgr = new XmlNamespaceManager(xmlResult.NameTable);

nsMgr.AddNamespace("sp", xReturn.NamespaceURI);

XmlNode ndRoot = xmlResult.SelectSingleNode("sp:Results", nsMgr);

// Find the ErrorCode node, which exists for all operations regardless of status.

XmlNodeList nlResults = ndRoot.SelectNodes("//sp:Result/sp:ErrorCode", nsMgr);

 

// Loop through the node collection and find each ErrorCode entry

foreach (XmlNode ndResult in nlResults)

{

// Check the value of the node to determine its status

if (ndResult.InnerText != "0x00000000")

{

XmlNode ndError = ndResult.NextSibling;

string sError = ndError.InnerText;

// Set the value of string variable to hold the error code

sStatus = "Update operation failed for " + sListName + ": " + sError + ".";

// If you want to trip the Try…Catch, throw and exception of whatever type suits you

throw new System.Exception();

}

else

{

sStatus = "Success";

return sStatus;

}

}

}

catch (Exception e)

{

e.Message = sStatus;

return sStatus;

}


The final result is pretty self-explanatory; either an exception that you can trap while debugging or a return string that you can parse (I know, I know…returning a string to circumvent a method that returns a string is counter-intuitive and generally a bad coding practice – that's why I added the exception code). This works for most SharePoint web services that return ErrorCode values (which some do not) so Your Mileage May Vary depending upon what you are trying to achieve.

 

Comments

Re: Trapping XML Errors Using SharePoint Web Services

Eric ~

Thanks for the post! I've posted a follow-up over at my blog: http://solutionizing.net/2008/06/21/web-service-results-xpath-is-your-friend/

Let me know what you think!

Cheers ~
Keith
System Account on 6/21/2008 2:05 AM

Excellent!

Thanks for the post. It was very helpful.
Rick McQ
 on 9/3/2011 11:20 PM

Add Comment

Items on this list require content approval. Your submission will not appear in public views until approved by someone with proper rights. More information on content approval.

Title


Body *


Comment Date *

Select a date from the calendar.
Enter the current date to prevent automated spambot comments.

Spam Prevention *


How many letters, not including spaces, does it take to spell "SharePoint Cowboy"?

Attachments

 
photo of Eric Shupps Eric Alan Shupps eshupps @eshupps SharePoint Cowboy BinaryWave Eric Shupps
BinaryWave
611 S. Main St., Suite 400
Grapevine , TX , 76051 USA

 
 
 
Eric Shupps Eric Alan Shupps eshupps @eshupps SharePoint Cowboy BinaryWave 

Eric Shupps LinkedIn Eric Shupps Twitter Eric Shupps Facebook Eric Shupps Google+
 
 

 


 


BinaryWave Eric Shupps eshupps The SharePoint Cowboy SharePoint monitoring SharePoint monitoring tool SharePoint metrics SharePoint administratrion SharePoint monitoring best practices SharePoint management SharePoint management tool SharePoint operations SharePoint operationsmanagement SharePoint administration SharePoint administration tool SharePoint SLA SharePoint service level agreement SharePoint operational intelligence SharePoint performance SharePoint performance monitoring SharePoint analytics SharePoint real-time SharePoint intelligence SharePoint ITIL SharePoint service operations SharePoint uptime SharePoint alerts SharePoint health SharePoint tools SharePoint metrics SharePoint diagnostics SharePoint SmartTrack SmartTrack Operational Intelligence


Copyright © 2013 BinaryWave, Inc. All rights reserved.
This site is brought to you by BinaryWave in cooperation with Eric Shupps Eric Alan Shupps eshupps @eshupps The SharePoint Cowboy. We hope you enjoy the SharePoint-related content on topics such as performance, monitoring, administration, operations, support, business intelligence and more for SharePoint 2010, SharePoint 2013 and Office 365 created by Eric Shupps The SharePoint Cowboy. We also hope you will visit our product pages to learn more about SmartTrack, Operational Analytics for SharePoint, SharePoint monitoring, and SharePoint administration, while also discovering great offers from our partners. Please visit the blog of Eric Alan Shupps, Twitter handle @eshupps, for more information on application development, the SharePoint community, SharePoint performance, and general technology topics. Eric Shupps Eric Alan Shupps eshupps @eshupps The SharePoint Cowboy is the founder and President of BinaryWave, a leading provider of operational support solutions for SharePoint. Eric Shupps Eric Alan Shupps eshupps @eshupps The SharePoint Cowboy has worked with SharePoint Products and Technologies since 2001 as a consultant, administrator, architect, developer and trainer. He is an advisory committee member of the Dallas/Ft. Worth SharePoint Community group and participating member of user groups throughout the United Kingdom. Eric Shupps Eric Alan Shupps eshupps @eshupps The SharePoint Cowboy has authored numerous articles on SharePoint, speaks at user group meetings and conferences around the world, and publishes a popular SharePoint blog at http://www.binarywave.com/blogs/eshupps.