This API is used to make changes to an existing document. The document data as well as name can be changed using this API. The API allows to edit the document, only if an edit permission is available for the API user on the requested document. The changes to the data , needs to be submitted as a complete document payload. The payload can include attachments / primary files also.
API Code
UPDATE_DOC
Request
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Body>
<UpdateDocument xmlns="http://ws.vg.com/pw/PWDataDx/1.0">
<DocumentId><!--The document id to be updated--></DocumentId>
<DocumentName><!-- Updated Name of the document --></DocumentName>
<DocumentDescription><!-- Updated Description for Document--></DocumentDescription>
<Payload>
<!-- The updated document payload here -->
</Payload>
</UpdateDocument>
</SOAP:Body>
</SOAP:Envelope>
Response
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Header/>
<SOAP:Body>
<UpdateDocumentResponse xmlns="http://ws.vg.com/pw/PWDataDx/1.0">
<DocumentId><!-- Platform id of the of the document --></DocumentId>
</UpdateDocumentResponse>
</SOAP:Body>
</SOAP:Envelope>
Request Parameters
The following table detail the request parameter used:
| Parameter | Description |
|---|---|
| DocumentId | This parameter gives the id of the document that needs to be updated. |
| DocumentName | This parameter gives the updated name of the document that needs to be updated. |
| DocumentDescription | This parameter gives the updated description of the document that needs to be updated. |
| Payload | This parameter gives the XML representation of this Collabrr document. |
Response Parameters
The following table detail the response parameter used:
| Parameter | Description |
|---|---|
| DocumentId | This parameter gives the id of the document. |