DigiOffice Gateway Web Services

<back to all web services

GetDocumentByFileUrl

Requires Authentication 
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Document.Operations
Imports IDB.API.DTO.Document

Namespace Global

    Namespace IDB.API.DTO.Document

        Public Partial Class Document
            Implements ICustomProperties
            Public Sub New()
                CustomProperties = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property RootDocumentID As Guid
            Public Overridable Property RegistrationprofileID As Guid
            Public Overridable Property Title As String
            Public Overridable Property FullTitle As String
            Public Overridable Property Number As String
            Public Overridable Property Version As String
            Public Overridable Property ExternalNumber As String
            Public Overridable Property ExternalVersion As String
            Public Overridable Property InternalNumber As String
            Public Overridable Property InternalInvoiceNumber As String
            Public Overridable Property PersonID As Integer
            Public Overridable Property RelationID As Integer
            Public Overridable Property RelationTitle As String
            Public Overridable Property ProjectID As Integer
            Public Overridable Property ProjectTitle As String
            Public Overridable Property Extension As String
            Public Overridable Property [Date] As Nullable(Of Date)
            Public Overridable Property CommentsCount As Integer
            Public Overridable Property HasComments As Boolean
            Public Overridable Property HasPreview As Boolean
            Public Overridable Property ExtraField As String
            Public Overridable Property IsFavorite As Boolean
            Public Overridable Property DocumentcategoryText As String
            Public Overridable Property FileSize As Nullable(Of Long)
            Public Overridable Property FileDate As Nullable(Of Date)
            Public Overridable Property Hash As String
            Public Overridable Property HashType As String
            Public Overridable Property FileUrl As String
            Public Overridable Property StandardDocumentUrl As String
            Public Overridable Property IsCorporateIdentity As Boolean
            Public Overridable Property UserTitle As String
            Public Overridable Property IsFrozen As Boolean
            Public Overridable Property InternalCompanyID As Integer
            Public Overridable Property DirectUrl As String
            Public Overridable Property AllowDigitalSigningOnlyOnPrimaryVersions As Boolean
            Public Overridable Property IsPrimaryVersion As Boolean
            Public Overridable Property FileExtension As String
            Public Overridable Property CustomProperties As Dictionary(Of String, Object)
        End Class
    End Namespace

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class GetDocumentByFileUrl
            Public Overridable Property FileUrl As String
        End Class
    End Namespace
End Namespace

VB.NET GetDocumentByFileUrl 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 /xml/reply/GetDocumentByFileUrl HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentByFileUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <FileUrl>String</FileUrl>
</GetDocumentByFileUrl>

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>