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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
using IDB.API.DTO.Document;
using IDB.API.DTO.MobileViews;
using IDB.API.DTO.Navigation;

namespace IDB.API.DTO.Document
{
    public partial class DocumentView
        : MobileView
    {
        [DataMember]
        public virtual string TranslateKey { get; set; }

        [DataMember]
        public virtual string SiteMapKey { get; set; }
    }

}

namespace IDB.API.DTO.Document.Operations
{
    public partial class GetDocumentViewDetails
    {
        public virtual string Key { get; set; }
        public virtual bool IncludeExplorers { get; set; }
    }

}

namespace IDB.API.DTO.MobileViews
{
    [DataContract]
    public partial class MobileView
    {
        public MobileView()
        {
            Explorers = new List<Explorer>{};
        }

        [DataMember]
        public virtual Guid ID { get; set; }

        [DataMember]
        public virtual string Title { get; set; }

        [DataMember]
        public virtual string ImageUrl { get; set; }

        [DataMember]
        public virtual int? ChildrenCount { get; set; }

        [DataMember]
        public virtual int Order { get; set; }

        [DataMember]
        public virtual List<Explorer> Explorers { get; set; }
    }

}

namespace IDB.API.DTO.Navigation
{
    public partial class Explorer
    {
        public virtual Guid ID { get; set; }
        public virtual string Title { get; set; }
        public virtual int Order { get; set; }
    }

}

C# GetDocumentViewDetails DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"Key":"String","IncludeExplorers":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TranslateKey":"String","SiteMapKey":"String","ID":"00000000-0000-0000-0000-000000000000","Title":"String","ImageUrl":"String","ChildrenCount":0,"Order":0,"Explorers":[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","Order":0}]}