2.2.4.8 SubResponseType

  • Article

The SubResponseType complex type contains information about a basic cell storage service subresponse. The SubResponseType is used as the base complex type to extend SubResponseElementGenericType. The SubResponseElementGenericType takes one of the following forms: CellSubResponseType, CoauthSubResponseType, SchemaLockSubResponseType, ExclusiveLockSubResponseType, ServerTimeSubResponseType, WhoAmISubResponseType, EditorsTableSubResponseType, GetDocMetaInfoSubResponseType, GetVersionsSubResponseType, VersioningSubResponseType, FileOperationSubResponseType, AmIAloneSubResponseType, LockStatusSubResponseType, or PropertiesSubResponseType. CellSubResponseType is specified in section 2.3.1.4. CoauthSubResponseType is specified in section 2.3.1.8. ExclusiveLockSubResponseType is specified in section 2.3.1.12. SchemaLockSubResponseType is specified in section 2.3.1.16. ServerTimeSubResponseType is specified in section 2.3.1.19. WhoAmISubResponseType is specified in section 2.3.1.22. EditorsTableSubResponseType is specified in section 2.3.1.25. GetDocMetaInfoSubResponseType is specified in section 2.3.1.30. GetVersionsSubResponseType is specified in section 2.3.1.32. FileOperationSubResponseType is specified in section 2.3.1.35. VersioningSubResponseType is specified in section 2.3.1.39. AmIAloneSubResponseType is specified in section 2.3.1.48. LockStatusSubResponseType is specified in section 2.3.1.51. PropertiesSubResponseType is specified in section 2.3.1.55.

 <xs:complexType name="SubResponseType">
    <xs:attribute name="SubRequestToken" type="xs:nonNegativeInteger" use="required"/>
    <xs:attribute name="ServerCorrelationId" type="tns:guid" use="optional"/>
    <xs:attribute name="ErrorCode" type="tns:ErrorCodeTypes" use="required" />
    <xs:attribute name="HResult" type="xs:integer" use="required"/>
    <xs:attribute name="ErrorMessage" type="xs:string" use="optional"/> 
 </xs:complexType>

SubRequestToken: A nonnegative integer that specifies a number that uniquely identifies the SubRequest element whose subresponse is being generated as part of the SubResponse element. The mapping subresponse that gets generated for the subrequest references the SubRequestToken to indicate that it is the response for that subrequest. The SubRequestToken attribute MUST be specified for a SubResponse element. The SubResponse element is defined in section 2.2.3.10. The SubRequest element is defined in section 2.2.3.8.

ServerCorrelationId: A guid that specifies a unique identifier that equals to the CorrelationId as specified in section 2.2.3.3.<18>

ErrorCode: An ErrorCodeTypes that specifies an error code value indicating the type of error that occurred during the processing of the corresponding SubRequest element. The SubRequest element is defined in section 2.2.3.8. ErrorCodeTypes is defined in section 2.2.5.4. The ErrorCode attribute MUST be specified for a SubResponse element.

HResult: An integer that specifies an error code specific to the subrequest that failed and that gives more hints about the cause of failure.

ErrorMessage: A string that specifies a description of the error code value and also provides additional information related to the error code. If the error code value is set to "FileAlreadyLockedOnServer", the protocol server returns the user name of the client that is currently holding the lock on the file.