Product Documentation articleError handling: lq851
Added by IBM contributorXiang Yu Hao | Edited by IBM contributorDana Liburdi on April 18, 2011 | Version 3
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.

Description



Apart from the HTTP response codes, the API provides a custom error code and message that clients will find useful when the HTTP response codes are ambiguous for a specific operation.

Example



In case of an error condition, the HTTP response body will contain the following sample XML content:

		<p3:getDocumentResponse xmlns:p0="http://exception.webservices.clb.content.ibm.com" xmlns:p1="http://model.xsd.clb.content.ibm.com" xmlns:p3="http://webservices.clb.content.ibm.com" xmlns:p2="http://view.model.xsd.clb.content.ibm.com" xmlns:p4="http://model.xsd.content.ibm.com" xmlns:p5="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:p6="http://schemas.xmlsoap.org/wsdl/" xmlns:p7="http://www.w3.org/2001/XMLSchema">
			<p3:getDocumentReturn >
				<p3:error  type="ItemNotFound"></p3:error>
				<p3:document xsi:nil="true"/>
			</p3:getDocumentReturn>
		</p3:getDocumentResponse>




Error Codes



The following error codes are defined:
Error Code
Description
AccessDenied
Returned when the cause of an error is due to a permission restriction with an HTTP 401 response
ItemNotFound
Returned when the cause of an error is related to a resource not being found with an HTTP 404 response
ItemExists
Returned when the cause of an error is related to a conflict with an existing resource with an HTTP 409 response
DocumentAlreadyLocked
Returned when the cause of an error is related to a conflict with a locked resource with an HTTP 409 response
DocumentNotLocked
Returned when the cause of an error is due to not locking a resource that requires locking in order to update with an HTTP 409 response
DraftSubmitted
Returned when the cause of an error is executing an operation on a resource that has a submitted draft
FixedFolder
Returned when the cause of an error is related to an invalid attempt to modify a fixed folder structure for a library
Unsupported Operation
Returned when the operation is not supported
InvalidPath
Returned when the resource path specified (i.e. in Slug header) contains invalid characters