Service: zimbraMail
Namespace: "urn:zimbraMail"
DiffDocument SOAP Command

Performs line by line diff of two revisions of a Document then returns a list of <chunk/> containing the result. Sections of text that are identical to both versions are indicated with disp="common". For each conflict the chunk will show disp="first", disp="second" or both.

     v3:
     line 1
     line 2
     line 3
     line 4
     line 5

     v4:
     line 1
     line 2
     line 3.6
     line 4
     line 5

     <DiffDocumentRequest xmlns:ns0="urn:zimbraMail">
       <doc v1="3" v2="4" id="641"/>
     </DiffDocumentRequest>

     <DiffDocumentResponse xmlns:ns0="urn:zimbraMail">
       <chunk disp="common">line 1
     line 2</chunk>
       <chunk disp="first">line 3</chunk>
       <chunk disp="second">line 3.6</chunk>
       <chunk disp="common">line 4
     line 5</chunk>
     </DiffDocumentResponse>
 

Authorization token required true
Admin Authorization token required false

DiffDocumentRequest

    <DiffDocumentRequest> ## DiffDocumentRequest
        <doc [id="{id}"] [v1="{revision-1} (Integer)"] [v2="{revision-2} (Integer)"] /> ## DiffDocumentVersionSpec
    </DiffDocumentRequest>

The following table describes elements and attributes you can define within a <DiffDocumentRequest> element:

XPath Required / Optional Description
/doc Optional (0 or 1) Diff document version specification
/doc@id Optional (0 or 1) Type:String
ID
/doc@v1 Optional (0 or 1) Type:Integer
Revision 1
/doc@v2 Optional (0 or 1) Type:Integer
Revision 2

DiffDocumentResponse

    <DiffDocumentResponse> ## DiffDocumentResponse
        (<chunk [disp="{disposition}"]>{text}</chunk> ## DispositionAndText)*
    </DiffDocumentResponse>

The following table describes elements and attributes you can define within a <DiffDocumentResponse> element:

XPath Required / Optional Description
/chunk Optional (0 or more) Type:{text}
Difference information in chunks
Description for element text content:Text
/chunk@disp Optional (0 or 1) Type:String
Disposition. Sections of text that are identical to both versions are indicated with disp="common". For each conflict the chunk will show disp="first" or disp="second"