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 java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class GetDocumentSearch implements IDocumentSearchCriteria
    {
        public String SearchCriteria = null;
        public Integer PageNumber = null;
        public Integer PageSize = null;
        public ArrayList<UUID> ExcludeID = null;
        public Boolean AllVersions = null;
        public Boolean Archived = null;
        
        public String getSearchCriteria() { return SearchCriteria; }
        public GetDocumentSearch setSearchCriteria(String value) { this.SearchCriteria = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public GetDocumentSearch setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public GetDocumentSearch setPageSize(Integer value) { this.PageSize = value; return this; }
        public ArrayList<UUID> getExcludeID() { return ExcludeID; }
        public GetDocumentSearch setExcludeID(ArrayList<UUID> value) { this.ExcludeID = value; return this; }
        public Boolean isAllVersions() { return AllVersions; }
        public GetDocumentSearch setAllVersions(Boolean value) { this.AllVersions = value; return this; }
        public Boolean isArchived() { return Archived; }
        public GetDocumentSearch setArchived(Boolean value) { this.Archived = value; return this; }
    }

    public static class SearchResult<DocumentIdentifier, UUID>
    {
        public ArrayList<DocumentIdentifier> Results = null;
        public Integer Total = null;
        
        public ArrayList<DocumentIdentifier> getResults() { return Results; }
        public SearchResult<DocumentIdentifier, UUID> setResults(ArrayList<DocumentIdentifier> value) { this.Results = value; return this; }
        public Integer getTotal() { return Total; }
        public SearchResult<DocumentIdentifier, UUID> setTotal(Integer value) { this.Total = value; return this; }
    }

    public static class DocumentIdentifier
    {
        public UUID ID = null;
        public String DisplayName = null;
        
        public UUID getId() { return ID; }
        public DocumentIdentifier setId(UUID value) { this.ID = value; return this; }
        public String getDisplayName() { return DisplayName; }
        public DocumentIdentifier setDisplayName(String value) { this.DisplayName = value; return this; }
    }

}

Java GetDocumentSearch DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
Content-Length: length

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