DigiOffice Gateway Web Services

GetDocumentViewDetails

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