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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetDocumentFileDetails
    {
        public UUID DocumentID = null;
        public Boolean IncludeContent = null;
        public UUID DocumentFieldID = null;
        
        public UUID getDocumentID() { return DocumentID; }
        public GetDocumentFileDetails setDocumentID(UUID value) { this.DocumentID = value; return this; }
        public Boolean isIncludeContent() { return IncludeContent; }
        public GetDocumentFileDetails setIncludeContent(Boolean value) { this.IncludeContent = value; return this; }
        public UUID getDocumentFieldID() { return DocumentFieldID; }
        public GetDocumentFileDetails setDocumentFieldID(UUID value) { this.DocumentFieldID = value; return this; }
    }

    public static class DocumentFile
    {
        public String Name = null;
        public String Extension = null;
        public Long Size = null;
        public byte[] Content = null;
        
        public String getName() { return Name; }
        public DocumentFile setName(String value) { this.Name = value; return this; }
        public String getExtension() { return Extension; }
        public DocumentFile setExtension(String value) { this.Extension = value; return this; }
        public Long getSize() { return Size; }
        public DocumentFile setSize(Long value) { this.Size = value; return this; }
        public byte[] getContent() { return Content; }
        public DocumentFile setContent(byte[] value) { this.Content = value; return this; }
    }

}

Java GetDocumentFileDetails DTOs

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

HTTP + JSV

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

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