CreateEditDocumentURL API¶

Creates a time-limited WebDAV URL for directly opening and editing a specific document in a WebDAV-enabled application such as Microsoft Office. The returned URL points to the document file and can be passed to Office applications to open it for in-place editing via WebDAV.

Endpoint¶

/srv.asmx/CreateEditDocumentURL

Methods¶

• GET /srv.asmx/CreateEditDocumentURL?authenticationTicket=...&DocumentPath=...

• POST /srv.asmx/CreateEditDocumentURL (form data)

• SOAP Action: http://tempuri.org/CreateEditDocumentURL

Parameters¶

Response¶

Success Response¶

<response success="true">

  <Value>/dav/sid-3f2504e0-4f89-11d3-9a0c-0305e82c3301/MyLibrary/Reports/Budget.xlsx</Value>

</response>

Error Response¶

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

Required Permissions¶

Any authenticated non-anonymous user may call this API. The document at DocumentPath must be accessible to the user (Read permission is sufficient to generate the URL).

Example¶

GET Request¶

GET /srv.asmx/CreateEditDocumentURL

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

  &DocumentPath=/MyLibrary/Reports/Budget.xlsx

HTTP/1.1

POST Request¶

POST /srv.asmx/CreateEditDocumentURL HTTP/1.1

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

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

&DocumentPath=/MyLibrary/Reports/Budget.xlsx

SOAP Request¶

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

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

  <soap:Body>

    <tns:CreateEditDocumentURL>

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

      <tns:DocumentPath>/MyLibrary/Reports/Budget.xlsx</tns:DocumentPath>

    </tns:CreateEditDocumentURL>

  </soap:Body>

</soap:Envelope>

Using the returned URL¶

Prepend your server's base URL to form the complete WebDAV address:

https://yourserver/dav/sid-3f2504e0-4f89-11d3-9a0c-0305e82c3301/MyLibrary/Reports/Budget.xlsx

Pass this full URL to an Office application (e.g. via ShellExecute on Windows, or the Office URI scheme ms-word:ofe|u|<url>) to open the document for direct editing.

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

When it works, it returns the WebDAV path to one document, with a fresh Office-edit session in it:

const root = await call('CreateEditDocumentURL', {
  authenticationTicket: ticket,
  DocumentPath: '/Finance/Reports/Budget.xlsx'
});

const url = location.origin + root.querySelector('Value').textContent;

Notes¶

• The returned Value is a document-specific WebDAV path. It points directly to the file and is intended for single-document edit sessions. To mount the entire infoRouter file system as a drive, use CreateDiskMountURL instead.

• Each call creates a new dedicated OfficeEdit DAV session ticket for the current user. This session is separate from the user's main authentication ticket.

• If the full WebDAV URL would exceed 215 characters (combined server base URL and encoded document path), the server automatically uses a short path format instead: /dav/sid-{ticket}/~D{documentId}.{extension}.

• The session ticket embedded in the URL has a limited lifetime. Generate the URL immediately before opening the document; do not cache and reuse it later.

• The document does not need to be checked out before calling this API. The WebDAV client is responsible for checkout/check-in via the DAV protocol during the edit session.

Related APIs¶

• CreateDiskMountURL - Create a root-level WebDAV mount URL for the entire infoRouter file system

• GetDocument - Retrieve properties and metadata of a document

• GetDownloadInfo - Get download URL and metadata for a document

Error Codes¶

The errorCode values this operation returns, checked against a running server: