DigiOffice Gateway Web Services

<back to all web services

GetDocumentFileDetails

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

Namespace Global

    Namespace IDB.API.DTO.Document

        Public Partial Class DocumentFile
            Public Sub New()
                Content = New Byte(){}
            End Sub

            Public Overridable Property Name As String
            Public Overridable Property Extension As String
            Public Overridable Property Size As Long
            Public Overridable Property Content As Byte()
        End Class
    End Namespace

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class GetDocumentFileDetails
            Public Overridable Property DocumentID As Guid
            Public Overridable Property IncludeContent As Boolean
            Public Overridable Property DocumentFieldID As Guid
        End Class
    End Namespace
End Namespace

VB.NET GetDocumentFileDetails DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/documents/{DocumentID}/filedetails HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Name":"String","Extension":"String","Size":0,"Content":"AA=="}