DigiOffice Gateway Web Services

GetDocumentSearch

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

namespace IDB.API.DTO.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentIdentifier() = 
        member val ID:Guid = new Guid() with get,set
        member val DisplayName:String = null with get,set

    [<AllowNullLiteral>]
    type GetDocumentSearch() = 
        member val SearchCriteria:String = null with get,set
        member val PageNumber:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set
        member val ExcludeID:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val AllVersions:Boolean = new Boolean() with get,set
        member val Archived:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type SearchResult<DocumentIdentifier, Guid>() = 
        member val Results:ResizeArray<DocumentIdentifier> = new ResizeArray<DocumentIdentifier>() with get,set
        member val Total:Int32 = new Int32() with get,set

F# 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>