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

export class DocumentFile
{
    public Name?: string;
    public Extension?: string;
    public Size?: number;
    public Content?: string;

    public constructor(init?: Partial<DocumentFile>) { (Object as any).assign(this, init); }
}

export class GetDocumentFileDetails
{
    public DocumentID?: string;
    public IncludeContent?: boolean;
    public DocumentFieldID?: string;

    public constructor(init?: Partial<GetDocumentFileDetails>) { (Object as any).assign(this, init); }
}

TypeScript GetDocumentFileDetails 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.

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

<DocumentFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <Content>AA==</Content>
  <Extension>String</Extension>
  <Name>String</Name>
  <Size>0</Size>
</DocumentFile>