DigiOffice Gateway Web Services

<back to all web services

GetDocumentSearch

Requires Authentication
The following routes are available for this service:
POST/api/documents/search
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.Common
Imports IDB.API.DTO.Document

Namespace Global

    Namespace IDB.API.DTO.Common

        Public Partial Class SearchResult(Of DocumentIdentifier, Guid)
            Public Sub New()
                Results = New List(Of DocumentIdentifier)
            End Sub

            Public Overridable Property Results As List(Of DocumentIdentifier)
            Public Overridable Property Total As Integer
        End Class
    End Namespace

    Namespace IDB.API.DTO.Document

        Public Partial Class DocumentIdentifier
            Public Overridable Property ID As Guid
            Public Overridable Property DisplayName As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class GetDocumentSearch
            Implements IDocumentSearchCriteria
            Public Sub New()
                ExcludeID = New List(Of Guid)
            End Sub

            Public Overridable Property SearchCriteria As String
            Public Overridable Property PageNumber As Integer
            Public Overridable Property PageSize As Integer
            Public Overridable Property ExcludeID As List(Of Guid)
            Public Overridable Property AllVersions As Boolean
            Public Overridable Property Archived As Nullable(Of Boolean)
        End Class
    End Namespace
End Namespace

VB.NET GetDocumentSearch 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/documents/search HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <AllVersions>false</AllVersions>
  <Archived>false</Archived>
  <ExcludeID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </ExcludeID>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <SearchCriteria>String</SearchCriteria>
</GetDocumentSearch>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchResultOfDocumentIdentifierguidGNR3VCgI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
    <d2p1:DocumentIdentifier>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
    </d2p1:DocumentIdentifier>
  </Results>
  <Total>0</Total>
</SearchResultOfDocumentIdentifierguidGNR3VCgI>