DigiOffice Gateway Web Services

<back to all web services

GetDocumentViewDetails

Requires Authentication
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 .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.

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

{
	Key: String,
	IncludeExplorers: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TranslateKey: String,
	SiteMapKey: String,
	Title: String,
	ImageUrl: String,
	ChildrenCount: 0,
	Order: 0,
	Explorers: 
	[
		{
			Title: String,
			Order: 0
		}
	]
}