newDocumentContainerAssociation
This method allows adding a document to the complex file container structure of another document.
Java class | |
---|---|
Request | web/wwwroot/ws/java/document/NewDocumentContainerAssociationRequestType.java |
Return | web/wwwroot/ws/java/document/NewDocumentContainerAssociationResponseType.java |
Request:
ID # | Required | Description |
---|---|---|
UpperLevelCategoryID | X | Upper level category ID #. |
UpperLevelDocumentID | X | Upper level document ID #. |
RevisionID | Upper level document revision ID #. If not informed, the current revision of the document will be used. | |
StructID | X | Container structure ID #. |
LowerLevelCategoryID | X | Lower level category ID #. |
LowerLevelDocumentID | X | Lower level document ID #. |
Request structure:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:newDocumentContainerAssociation>
<!--You may enter the following 6 items in any order-->
<urn:UpperLevelCategoryID>?</urn:UpperLevelCategoryID>
<urn:UpperLevelDocumentID>?</urn:UpperLevelDocumentID>
<urn:RevisionID>?</urn:RevisionID>
<urn:StructID>?</urn:StructID>
<urn:LowerLevelCategoryID>?</urn:LowerLevelCategoryID>
<urn:LowerLevelDocumentID>?</urn:LowerLevelDocumentID>
</urn:newDocumentContainerAssociation>
</soapenv:Body>
</soapenv:Envelope>
Return:
ID # | Description |
---|---|
Status | Returns the status of the execution. SUCCESS on success and FAILURE on failure. |
Code | Returns the execution code: • 0 - Document associated successfully; • 1 - Required parameter not entered; • 2 - Upper level document not found; • 3 - Lower level document not found; • 4 - Structure not found in the container of the document category; • 5 - Entered structure is not in the “SoftExpert Document file” format; • 6 - Document already associated; • 7 - Upper level document category not found; • 8 - Revision ID # not found; • 9 - User does not have permission to edit the document; • 10 - Lower level document category not found; |
Detail | Message detailing the error or success in the execution of the method. |