DigiOffice Gateway Web Services

<back to all web services

GetDocumentAttachmentsByEntityType

Requires Authentication
The following routes are available for this service:
GET/api/entity/{EntityType}/{ID}/attachments
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class GetDocumentAttachmentsByEntityType
    {
        public String ID = null;
        public String EntityType = null;
        public Boolean IncludeSelf = null;
        
        public String getId() { return ID; }
        public GetDocumentAttachmentsByEntityType setId(String value) { this.ID = value; return this; }
        public String getEntityType() { return EntityType; }
        public GetDocumentAttachmentsByEntityType setEntityType(String value) { this.EntityType = value; return this; }
        public Boolean isIncludeSelf() { return IncludeSelf; }
        public GetDocumentAttachmentsByEntityType setIncludeSelf(Boolean value) { this.IncludeSelf = value; return this; }
    }

}

Java GetDocumentAttachmentsByEntityType 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/entity/{EntityType}/{ID}/attachments HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDocumentAttachment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <DocumentAttachment>
    <DetailUrl>String</DetailUrl>
    <DownloadName>String</DownloadName>
    <ID>00000000-0000-0000-0000-000000000000</ID>
    <IsMainDocument>false</IsMainDocument>
    <IsPrefferedDocument>false</IsPrefferedDocument>
    <Link>String</Link>
    <LinkTypeDescription>String</LinkTypeDescription>
    <Title>String</Title>
  </DocumentAttachment>
</ArrayOfDocumentAttachment>