2.2.5.6 GenericErrorCodeTypes

  • Article

The GenericErrorCodeTypes simple type is used to represent generic error code types that occur during cell storage service subrequest processing. 

 <xs:simpleType name="GenericErrorCodeTypes">
     <xs:restriction base="xs:string">
       <xs:enumeration value="Success"/>
       <xs:enumeration value="IncompatibleVersion"/>
       <xs:enumeration value="InvalidUrl"/>
       <xs:enumeration value="FileNotExistsOrCannotBeCreated"/>
       <xs:enumeration value="FileUnauthorizedAccess"/>
       <xs:enumeration value="PathNotFound"/>
       <xs:enumeration value="ResourceIdDoesNotExist"/>
       <xs:enumeration value="ResourceIdDoesNotMatch"/>
       <xs:enumeration value="InvalidSubRequest"/>
       <xs:enumeration value="SubRequestFail"/>
       <xs:enumeration value="BlockedFileType"/>
       <xs:enumeration value="DocumentCheckoutRequired"/>
       <xs:enumeration value="InvalidArgument"/>
       <xs:enumeration value="RequestNotSupported"/>
       <xs:enumeration value="InvalidWebUrl"/>
       <xs:enumeration value="WebServiceTurnedOff"/>
       <xs:enumeration value="ColdStoreConcurrencyViolation"/>
       <xs:enumeration value="HighLevelExceptionThrown"/>
       <xs:enumeration value="Unknown"/>
     </xs:restriction>
 </xs:simpleType>

The value of GenericErrorCodeTypes MUST be one of the values in the following table.

Value

Meaning

"Success"

Indicates that the cell storage service subrequest succeeded for the given URL for the file.

"IncompatibleVersion"

Indicates an error when any an incompatible version number is specified as part of the RequestVersion element of the cell storage service.

"InvalidUrl"

Indicates that the associated protocol server site URL is empty.

"FileNotExistsOrCannotBeCreated"

Indicates an error when either the targeted URL for the file specified as part of the Request element does not exist or file creation failed on the protocol server.

"FileUnauthorizedAccess"

Indicates an error when the targeted URL for the file specified as part of the Request element does not have correct authorization.

"PathNotFound"<20>

Indicates an error when the file path is not found.

"ResourceIdDoesNotExist"

Indicates an error when neither of the ResourceID and Url attributes identify valid files.

"ResourceIdDoesNotMatch"

Indicates an error when the ResourceID does not identify a valid file but Url attribute identify a valid file.

"InvalidSubRequest"

Indicates an error when one or more SubRequest elements for a targeted URL for the file were unable to be parsed.

"SubRequestFail"

Indicates an unknown error when processing any SubRequest element for a targeted URL for the file.

"BlockedFileType"

Indicates an error when the targeted URL to the file's file type is blocked on the protocol server.

"DocumentCheckoutRequired"

Indicates an error when the targeted URL for the file is not yet checked out by the current client before sending a lock request on the file. The client sends a CheckoutFile web service request, as specified in [MS-LISTSWS], before the protocol client gets a lock on the file. If the document is not checked out by the current client, the protocol server MUST return an error code value set to "DocumentCheckoutRequired" in the cell storage service response message.

"InvalidArgument"

Indicates an error when any of the cell storage service subrequests for the targeted URL for the file contains input parameters that are not valid.

"RequestNotSupported"

Indicates an error when the targeted cell storage service subrequest is a valid subrequest, but the server does not support that subrequest.

"InvalidWebUrl"

Indicates an error when the associated protocol server site URL is not found.

"WebServiceTurnedOff"<21>

Indicates an error when the web service is turned off during the processing of the cell storage service request.

"ColdStoreConcurrencyViolation"

Indicates an error when the file that is correctly stored on the server is modified by another user before the current user finished writing to the underlying store. The "ColdStoreConcurrencyViolation" error code value MUST only be sent as part of processing one of the following types of cell storage service request messages:

  • Cell

  • Coauth

  • SchemaLock

  • ExclusiveLock

The protocol client can retry the request if this error occurs.

"HighLevelExceptionThrown"<22>

Indicates any undefined error that occurs during the processing of the cell storage service request. This could be caused by a temporarily unavailable resource​ such as a network or machine.

"Unknown"

Indicates any undefined error that occurs during the processing of the cell storage service request.