DigiOffice Gateway Web Services

<back to all web services

GetDocumentUrl

Requires Authentication
The following routes are available for this service:
GET POST/api/documents/{DocumentID}/wopipreviewurl
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Document.Operations

Namespace Global

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class GetDocumentUrl
            Public Overridable Property DocumentID As Guid
        End Class

        Public Partial Class GetDocumentUrlResponse
            Public Overridable Property Url As String
            Public Overridable Property IsSharePointOnlineDocument As Boolean
        End Class
    End Namespace
End Namespace

VB.NET GetDocumentUrl DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/documents/{DocumentID}/wopipreviewurl HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
</GetDocumentUrl>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDocumentUrlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <IsSharePointOnlineDocument>false</IsSharePointOnlineDocument>
  <Url>String</Url>
</GetDocumentUrlResponse>