DigiOffice Gateway Web Services

<back to all web services

GetDocumentSearch

Requires Authentication
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SearchCriteria: String,
	PageNumber: 0,
	PageSize: 0,
	ExcludeID: 
	[
		00000000-0000-0000-0000-000000000000
	],
	AllVersions: False,
	Archived: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			DisplayName: String
		}
	],
	Total: 0
}