apidocs

DocumentExists API

Checks whether a document exists at the specified path and returns CRC32 checksums for the latest version and the published version. A successful response confirms the document exists; an error response indicates the path was not found.

Endpoint


/srv.asmx/DocumentExists

Methods

GET /srv.asmx/DocumentExists?authenticationTicket=...&Path=...
POST /srv.asmx/DocumentExists (form data)
SOAP Action: http://tempuri.org/DocumentExists

Parameters

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`Path`	string	Yes	Full infoRouter path of the document (e.g. `/MyLibrary/Reports/Report.pdf`), or a short document path in the form `~D{documentId}.{ext}` (e.g. `~D4217.pdf`).

Response

Success Response

<response success="true" CRC32LASTVERSION="a3f1c29d" CRC32="b7e4d80c" />

Attribute	Description
`success`	`true` if the document was found.
`CRC32LASTVERSION`	CRC32 checksum of the latest version’s file content.
`CRC32`	CRC32 checksum of the published version’s file content. Empty string if no version has been published.

Error Response

<response success="false" error="Error message" />

Required Permissions

Any authenticated user may call this API. The document must be accessible to the authenticated user.

Example

GET Request

GET /srv.asmx/DocumentExists

  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &Path=/MyLibrary/Reports/Report.pdf

HTTP/1.1

GET Request with Short Path

GET /srv.asmx/DocumentExists

  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &Path=~D4217.pdf

HTTP/1.1

POST Request

POST /srv.asmx/DocumentExists HTTP/1.1

Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&Path=/MyLibrary/Reports/Report.pdf

SOAP Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:DocumentExists>

      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>

      <tns:Path>/MyLibrary/Reports/Report.pdf</tns:Path>

    </tns:DocumentExists>

  </soap:Body>

</soap:Envelope>

Notes

Despite its name, this API does more than confirm existence -“ it also returns CRC32 checksums that can be used to verify document content without downloading the file.
The CRC32 (published version checksum) attribute is an empty string when no version of the document has been published.
Short document paths in the form ~D{documentId}.{ext} are accepted as an alternative to full folder paths. Any other path starting with ~ (but not ~D) is rejected with an InvalidDocumentIdentifer error.
Use DocumentExists1 to look up a document by folder path and document name separately instead of a combined full path.

DocumentExists1 - Check document existence using a folder path and document name as separate parameters
GetDocument - Get full document properties
FolderExists - Check whether a folder exists at a given path

Error Codes

Error	Description
`[900] Authentication failed`	Invalid or missing authentication ticket.
`[901] Session expired or Invalid ticket`	The ticket has expired or does not exist.
`Document not found`	No document exists at the specified `Path`.
`InvalidDocumentIdentifer`	`Path` starts with `~` but is not a valid short document path (`~D` prefix).