Trendsic Platform Service

DocumentSearchRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/DocumentSearch

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public enum DocumentSearchMode
    {
        Exact = 1,
        Contains = 2,
        StartsWith = 3,
        EndsWith = 4,
    }

    public partial class DocumentSearchRequest
    {
        public virtual string searchTerms { get; set; }
        public virtual DocumentSearchMode searchMode { get; set; }
        public virtual DocumentTermMode termMode { get; set; }
        public virtual Guid userId { get; set; }
    }

    public partial class DocumentSearchResponse
    {
        public virtual int DocumentSearchCount { get; set; }
        public virtual List<DocumentSearchResult> DocumentSearchResults { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DocumentSearchResult
    {
        public virtual Guid AttachmentId { get; set; }
        public virtual DateTime DateAdded { get; set; }
        public virtual string AttachmentName { get; set; }
        public virtual string Description { get; set; }
        public virtual string DocumentType { get; set; }
        public virtual string DocumentGroup { get; set; }
        public virtual string DropboxTableName { get; set; }
        public virtual int DropboxRecordId { get; set; }
        public virtual string AttachmentTableName { get; set; }
        public virtual string AttachmentFieldName { get; set; }
        public virtual int AttachmentRecordId { get; set; }
        public virtual string FilePath { get; set; }
        public virtual string OCRSource { get; set; }
        public virtual string OCRResult { get; set; }
        public virtual List<LineSearchResult> Lines { get; set; } = [];
    }

    public enum DocumentTermMode
    {
        All = 1,
        Any = 2,
    }

    public partial class LineSearchResult
    {
        public virtual string LineText { get; set; }
        public virtual int PageNo { get; set; }
        public virtual int PageLineNo { get; set; }
        public virtual int DocLineNo { get; set; }
        public virtual double BoxTop { get; set; }
        public virtual double BoxLeft { get; set; }
        public virtual double BoxWidth { get; set; }
        public virtual double BoxHeight { get; set; }
    }

}

C# DocumentSearchRequest 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 /v1/DocumentSearch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"searchTerms":"String","searchMode":"Exact","termMode":"All","userId":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DocumentSearchCount":0,"DocumentSearchResults":[{"AttachmentId":"00000000000000000000000000000000","DateAdded":"0001-01-01T00:00:00.0000000","AttachmentName":"String","Description":"String","DocumentType":"String","DocumentGroup":"String","DropboxTableName":"String","DropboxRecordId":0,"AttachmentTableName":"String","AttachmentFieldName":"String","AttachmentRecordId":0,"FilePath":"String","OCRSource":"String","OCRResult":"String","Lines":[{"LineText":"String","PageNo":0,"PageLineNo":0,"DocLineNo":0,"BoxTop":0,"BoxLeft":0,"BoxWidth":0,"BoxHeight":0}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}