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


export class LineSearchResult
{
    public LineText: string;
    public PageNo: number;
    public PageLineNo: number;
    public DocLineNo: number;
    public BoxTop: number;
    public BoxLeft: number;
    public BoxWidth: number;
    public BoxHeight: number;

    public constructor(init?: Partial<LineSearchResult>) { (Object as any).assign(this, init); }
}

export class DocumentSearchResult
{
    public AttachmentId: string;
    public DateAdded: string;
    public AttachmentName: string;
    public Description: string;
    public DocumentType: string;
    public DocumentGroup: string;
    public DropboxTableName: string;
    public DropboxRecordId: number;
    public AttachmentTableName: string;
    public AttachmentFieldName: string;
    public AttachmentRecordId: number;
    public FilePath: string;
    public OCRSource: string;
    public OCRResult: string;
    public Lines: LineSearchResult[] = [];

    public constructor(init?: Partial<DocumentSearchResult>) { (Object as any).assign(this, init); }
}

export class DocumentSearchResponse
{
    public DocumentSearchCount: number;
    public DocumentSearchResults: DocumentSearchResult[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DocumentSearchResponse>) { (Object as any).assign(this, init); }
}

export enum DocumentSearchMode
{
    Exact = 1,
    Contains = 2,
    StartsWith = 3,
    EndsWith = 4,
}

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

export class DocumentSearchRequest
{
    public searchTerms: string;
    public searchMode: DocumentSearchMode;
    public termMode: DocumentTermMode;
    public userId: string;

    public constructor(init?: Partial<DocumentSearchRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"}}}