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
namespace IDB.API.DTO.Document

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentFile() = 
        member val Name:String = null with get,set
        member val Extension:String = null with get,set
        member val Size:Int64 = new Int64() with get,set
        member val Content:Byte[] = [||] with get,set

    [<AllowNullLiteral>]
    type GetDocumentFileDetails() = 
        member val DocumentID:Guid = new Guid() with get,set
        member val IncludeContent:Boolean = new Boolean() with get,set
        member val DocumentFieldID:Guid = new Guid() with get,set

F# GetDocumentFileDetails DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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