DigiOffice Gateway Web Services

<back to all web services

GetDocumentSearch

Requires Authentication
The following routes are available for this service:
POST/api/documents/search
import Foundation
import ServiceStack

public class GetDocumentSearch : IDocumentSearchCriteria, Codable
{
    public var searchCriteria:String
    public var pageNumber:Int
    public var pageSize:Int
    public var excludeID:[String] = []
    public var allVersions:Bool
    public var archived:Bool?

    required public init(){}
}

public class SearchResult<DocumentIdentifier : Codable, String : Codable> : Codable
{
    public var results:[DocumentIdentifier] = []
    public var total:Int

    required public init(){}
}

public class DocumentIdentifier : Codable
{
    public var id:String
    public var displayName:String

    required public init(){}
}


Swift 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
}