DigiOffice Gateway Web Services

<back to all web services

GetDocumentSearch

Requires Authentication
The following routes are available for this service:
POST/api/documents/search
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
using IDB.API.DTO.Common;
using IDB.API.DTO.Document;

namespace IDB.API.DTO.Common
{
    public partial class SearchResult<DocumentIdentifier, Guid>
    {
        public SearchResult()
        {
            Results = new List<DocumentIdentifier>{};
        }

        public virtual List<DocumentIdentifier> Results { get; set; }
        public virtual int Total { get; set; }
    }

}

namespace IDB.API.DTO.Document
{
    public partial class DocumentIdentifier
    {
        public virtual Guid ID { get; set; }
        public virtual string DisplayName { get; set; }
    }

}

namespace IDB.API.DTO.Document.Operations
{
    public partial class GetDocumentSearch
        : IDocumentSearchCriteria
    {
        public GetDocumentSearch()
        {
            ExcludeID = new List<Guid>{};
        }

        public virtual string SearchCriteria { get; set; }
        public virtual int PageNumber { get; set; }
        public virtual int PageSize { get; set; }
        public virtual List<Guid> ExcludeID { get; set; }
        public virtual bool AllVersions { get; set; }
        public virtual bool? Archived { get; set; }
    }

}

C# GetDocumentSearch DTOs

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

HTTP + CSV

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

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