DigiOffice Gateway Web Services

GetDocumentViewDetails

The following routes are available for this service:
GET POST	/api/documentviews/{Key}

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetDocumentViewDetails
    {
        public String Key = null;
        public Boolean IncludeExplorers = null;
        
        public String getKey() { return Key; }
        public GetDocumentViewDetails setKey(String value) { this.Key = value; return this; }
        public Boolean isIncludeExplorers() { return IncludeExplorers; }
        public GetDocumentViewDetails setIncludeExplorers(Boolean value) { this.IncludeExplorers = value; return this; }
    }

    public static class DocumentView extends MobileView
    {
        @DataMember
        public String TranslateKey = null;

        @DataMember
        public String SiteMapKey = null;
        
        public String getTranslateKey() { return TranslateKey; }
        public DocumentView setTranslateKey(String value) { this.TranslateKey = value; return this; }
        public String getSiteMapKey() { return SiteMapKey; }
        public DocumentView setSiteMapKey(String value) { this.SiteMapKey = value; return this; }
    }

    @DataContract
    public static class MobileView
    {
        @DataMember
        public UUID ID = null;

        @DataMember
        public String Title = null;

        @DataMember
        public String ImageUrl = null;

        @DataMember
        public Integer ChildrenCount = null;

        @DataMember
        public Integer Order = null;

        @DataMember
        public ArrayList<Explorer> Explorers = null;
        
        public UUID getId() { return ID; }
        public MobileView setId(UUID value) { this.ID = value; return this; }
        public String getTitle() { return Title; }
        public MobileView setTitle(String value) { this.Title = value; return this; }
        public String getImageUrl() { return ImageUrl; }
        public MobileView setImageUrl(String value) { this.ImageUrl = value; return this; }
        public Integer getChildrenCount() { return ChildrenCount; }
        public MobileView setChildrenCount(Integer value) { this.ChildrenCount = value; return this; }
        public Integer getOrder() { return Order; }
        public MobileView setOrder(Integer value) { this.Order = value; return this; }
        public ArrayList<Explorer> getExplorers() { return Explorers; }
        public MobileView setExplorers(ArrayList<Explorer> value) { this.Explorers = value; return this; }
    }

    public static class Explorer
    {
        public UUID ID = null;
        public String Title = null;
        public Integer Order = null;
        
        public UUID getId() { return ID; }
        public Explorer setId(UUID value) { this.ID = value; return this; }
        public String getTitle() { return Title; }
        public Explorer setTitle(String value) { this.Title = value; return this; }
        public Integer getOrder() { return Order; }
        public Explorer setOrder(Integer value) { this.Order = value; return this; }
    }

}

Java GetDocumentViewDetails 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.

POST /api/documentviews/{Key} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentViewDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <IncludeExplorers>false</IncludeExplorers>
  <Key>String</Key>
</GetDocumentViewDetails>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <ChildrenCount xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</ChildrenCount>
  <Explorers xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Navigation" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">
    <d2p1:Explorer>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:Explorer>
  </Explorers>
  <ID xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">00000000-0000-0000-0000-000000000000</ID>
  <ImageUrl xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">String</ImageUrl>
  <Order xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</Order>
  <Title xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">String</Title>
  <SiteMapKey>String</SiteMapKey>
  <TranslateKey>String</TranslateKey>
</DocumentView>