2.3.1.7 CoauthSubResponseDataType

  • Article

The CoauthSubResponseDataType complex type contains information requested as part of the corresponding coauthoring subrequest. 

 <xs:complexType name="CoauthSubResponseDataType">
     <xs:attribute name="LockType" type="tns:LockTypes" use="optional" />
     <xs:attribute name="CoauthStatus" type="tns:CoauthStatusType" use="optional"/>
     <xs:attribute name="TransitionID" type="tns:guid" use="optional"/>
     <xs:attribute name="ExclusiveLockReturnReason" type="tns:ExclusiveLockReturnReasonTypes" use="optional" />
 </xs:complexType>

LockType: A LockTypes that specifies the type of lock granted in a coauthoring subresponse. LockTypes is defined in section 2.2.5.9. If the ErrorCode attribute that is part of the SubResponse element is set to a value of "Success", the LockType attribute MUST be specified in a coauthoring subresponse that is generated in response to all of the following types of coauthoring subrequests:

  • Join coauthoring session

  • Refresh coauthoring session

The different types of coauthoring subrequests are defined in section 2.3.3.3.

CoauthStatus: A CoauthStatusType that specifies the coauthoring status in a coauthoring subresponse. The CoauthStatusType is defined in section 2.2.5.1. If the ErrorCode attribute that is part of the SubResponse element is set to a value of "Success", CoauthStatus MUST be specified in a coauthoring subresponse that is generated in response to all of the following types of coauthoring subrequests:

  • Join coauthoring session<30>

  • Refresh coauthoring session

  • Get coauthoring status.

The different types of coauthoring subrequest are defined in section 2.3.3.3.

TransitionID: A guid that specifies the unique file identifier stored for that file on the protocol server. The guid type is defined in section 2.2.5.7.  TransitionID serves as an input parameter to the IsOnlyClient web service request as specified in [MS-SHDACCWS]. The transition identifier MUST be returned by a coauthoring subrequest of type "Join coauthoring session".

ExclusiveLockReturnReason: An ExclusiveLockReturnReasonTypes that specifies the reason why an exclusive lock is granted in a coauthoring subresponse. ExclusiveLockReturnReasonTypes is defined in section 2.2.5.5. The ExclusiveLockReturnReason attribute MUST be specified in a coauthoring subresponse that is generated in response to the JoinCoauthoring type of coauthoring subrequest when the LockType attribute in the subresponse is set to "ExclusiveLock".

The types of coauthoring subrequests are defined in section 2.3.3.3.