DigiOffice Gateway Web Services

GetDocumentByNumber

Get the details of a document by reference number

The following routes are available for this service:
POST	/api/documents/number

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

        '''<Summary>
        '''Get the details of a document by reference number
        '''</Summary>
        <Api(Description:="Get the details of a document by reference number")>
        Public Partial Class GetDocumentByNumber
            Public Overridable Property Number As String
            Public Overridable Property Version As String
        End Class
    End Namespace
End Namespace

VB.NET GetDocumentByNumber 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 /api/documents/number HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Number":"String","Version":"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":{}}}