DigiOffice Gateway Web Services

<back to all web services

GetDocumentNewestDetails

Requires Authentication
The following routes are available for this service:
GET/api/documents/{DocumentID}/newest
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;

namespace IDB.API.DTO.Document
{
    public partial class Document
        : ICustomProperties
    {
        public Document()
        {
            CustomProperties = new Dictionary<string, Object>{};
        }

        public virtual Guid ID { get; set; }
        public virtual Guid RootDocumentID { get; set; }
        public virtual Guid RegistrationprofileID { get; set; }
        public virtual string Title { get; set; }
        public virtual string FullTitle { get; set; }
        public virtual string Number { get; set; }
        public virtual string Version { get; set; }
        public virtual string ExternalNumber { get; set; }
        public virtual string ExternalVersion { get; set; }
        public virtual string InternalNumber { get; set; }
        public virtual string InternalInvoiceNumber { get; set; }
        public virtual int PersonID { get; set; }
        public virtual int RelationID { get; set; }
        public virtual string RelationTitle { get; set; }
        public virtual int ProjectID { get; set; }
        public virtual string ProjectTitle { get; set; }
        public virtual string Extension { get; set; }
        public virtual DateTime? Date { get; set; }
        public virtual int CommentsCount { get; set; }
        public virtual bool HasComments { get; set; }
        public virtual bool HasPreview { get; set; }
        public virtual string ExtraField { get; set; }
        public virtual bool IsFavorite { get; set; }
        public virtual string DocumentcategoryText { get; set; }
        public virtual long? FileSize { get; set; }
        public virtual DateTime? FileDate { get; set; }
        public virtual string Hash { get; set; }
        public virtual string HashType { get; set; }
        public virtual string FileUrl { get; set; }
        public virtual string StandardDocumentUrl { get; set; }
        public virtual bool IsCorporateIdentity { get; set; }
        public virtual string UserTitle { get; set; }
        public virtual bool IsFrozen { get; set; }
        public virtual int InternalCompanyID { get; set; }
        public virtual string DirectUrl { get; set; }
        public virtual bool AllowDigitalSigningOnlyOnPrimaryVersions { get; set; }
        public virtual bool IsPrimaryVersion { get; set; }
        public virtual string FileExtension { get; set; }
        public virtual Dictionary<string, Object> CustomProperties { get; set; }
    }

}

namespace IDB.API.DTO.Document.Operations
{
    public partial class GetDocumentNewestDetails
    {
        public virtual Guid DocumentID { get; set; }
        public virtual bool IncludeCustomProperties { get; set; }
    }

}

C# GetDocumentNewestDetails 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/documents/{DocumentID}/newest HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <AllowDigitalSigningOnlyOnPrimaryVersions>false</AllowDigitalSigningOnlyOnPrimaryVersions>
  <CommentsCount>0</CommentsCount>
  <CustomProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </CustomProperties>
  <Date>0001-01-01T00:00:00</Date>
  <DirectUrl>String</DirectUrl>
  <DocumentcategoryText>String</DocumentcategoryText>
  <Extension>String</Extension>
  <ExternalNumber>String</ExternalNumber>
  <ExternalVersion>String</ExternalVersion>
  <ExtraField>String</ExtraField>
  <FileDate>0001-01-01T00:00:00</FileDate>
  <FileExtension>String</FileExtension>
  <FileSize>0</FileSize>
  <FileUrl>String</FileUrl>
  <FullTitle>String</FullTitle>
  <HasPreview>false</HasPreview>
  <Hash>String</Hash>
  <HashType>String</HashType>
  <ID>00000000-0000-0000-0000-000000000000</ID>
  <InternalCompanyID>0</InternalCompanyID>
  <InternalInvoiceNumber>String</InternalInvoiceNumber>
  <InternalNumber>String</InternalNumber>
  <IsCorporateIdentity>false</IsCorporateIdentity>
  <IsFavorite>false</IsFavorite>
  <IsFrozen>false</IsFrozen>
  <IsPrimaryVersion>false</IsPrimaryVersion>
  <Number>String</Number>
  <PersonID>0</PersonID>
  <ProjectID>0</ProjectID>
  <ProjectTitle>String</ProjectTitle>
  <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID>
  <RelationID>0</RelationID>
  <RelationTitle>String</RelationTitle>
  <RootDocumentID>00000000-0000-0000-0000-000000000000</RootDocumentID>
  <StandardDocumentUrl>String</StandardDocumentUrl>
  <Title>String</Title>
  <UserTitle>String</UserTitle>
  <Version>String</Version>
</Document>