DigiOffice Gateway Web Services

<back to all web services

GetDocumentByFileUrl

Requires Authentication
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 GetDocumentByFileUrl
    {
        public virtual string FileUrl { get; set; }
    }

}

C# GetDocumentByFileUrl DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetDocumentByFileUrl HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FileUrl":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","RegistrationprofileID":"00000000-0000-0000-0000-000000000000","Title":"String","FullTitle":"String","Number":"String","Version":"String","ExternalNumber":"String","ExternalVersion":"String","InternalNumber":"String","InternalInvoiceNumber":"String","PersonID":0,"RelationID":0,"RelationTitle":"String","ProjectID":0,"ProjectTitle":"String","Extension":"String","Date":"0001-01-01T00:00:00.0000000","CommentsCount":0,"HasComments":false,"HasPreview":false,"ExtraField":"String","IsFavorite":false,"DocumentcategoryText":"String","FileSize":0,"FileDate":"0001-01-01T00:00:00.0000000","Hash":"String","HashType":"String","FileUrl":"String","StandardDocumentUrl":"String","IsCorporateIdentity":false,"UserTitle":"String","IsFrozen":false,"InternalCompanyID":0,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false,"FileExtension":"String","CustomProperties":{"String":{}}}