DigiOffice Gateway Web Services

<back to all web services

GetDocumentSearch

Requires Authentication
The following routes are available for this service:
POST/api/documents/search
GetDocumentSearch Parameters:
NameParameterData TypeRequiredDescription
SearchCriteriabodystringNo
PageNumberbodyintNo
PageSizebodyintNo
ExcludeIDbodyList<Guid>No
AllVersionsbodyboolNo
Archivedbodybool?No
SearchResult<DocumentIdentifier, Guid> Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<DocumentIdentifier>No
TotalformintNo
DocumentIdentifier Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
DisplayNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

{"Results":[{"ID":"00000000-0000-0000-0000-000000000000","DisplayName":"String"}],"Total":0}