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

"use strict";
export class LineSearchResult {
    /** @param {{LineText?:string,PageNo?:number,PageLineNo?:number,DocLineNo?:number,BoxTop?:number,BoxLeft?:number,BoxWidth?:number,BoxHeight?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LineText;
    /** @type {number} */
    PageNo;
    /** @type {number} */
    PageLineNo;
    /** @type {number} */
    DocLineNo;
    /** @type {number} */
    BoxTop;
    /** @type {number} */
    BoxLeft;
    /** @type {number} */
    BoxWidth;
    /** @type {number} */
    BoxHeight;
}
export class DocumentSearchResult {
    /** @param {{AttachmentId?:string,DateAdded?:string,AttachmentName?:string,Description?:string,DocumentType?:string,DocumentGroup?:string,DropboxTableName?:string,DropboxRecordId?:number,AttachmentTableName?:string,AttachmentFieldName?:string,AttachmentRecordId?:number,FilePath?:string,OCRSource?:string,OCRResult?:string,Lines?:LineSearchResult[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    DateAdded;
    /** @type {string} */
    AttachmentName;
    /** @type {string} */
    Description;
    /** @type {string} */
    DocumentType;
    /** @type {string} */
    DocumentGroup;
    /** @type {string} */
    DropboxTableName;
    /** @type {number} */
    DropboxRecordId;
    /** @type {string} */
    AttachmentTableName;
    /** @type {string} */
    AttachmentFieldName;
    /** @type {number} */
    AttachmentRecordId;
    /** @type {string} */
    FilePath;
    /** @type {string} */
    OCRSource;
    /** @type {string} */
    OCRResult;
    /** @type {LineSearchResult[]} */
    Lines = [];
}
export class DocumentSearchResponse {
    /** @param {{DocumentSearchCount?:number,DocumentSearchResults?:DocumentSearchResult[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentSearchCount;
    /** @type {DocumentSearchResult[]} */
    DocumentSearchResults = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
/** @typedef {number} */
export var DocumentSearchMode;
(function (DocumentSearchMode) {
    DocumentSearchMode[DocumentSearchMode["Exact"] = 1] = "Exact"
    DocumentSearchMode[DocumentSearchMode["Contains"] = 2] = "Contains"
    DocumentSearchMode[DocumentSearchMode["StartsWith"] = 3] = "StartsWith"
    DocumentSearchMode[DocumentSearchMode["EndsWith"] = 4] = "EndsWith"
})(DocumentSearchMode || (DocumentSearchMode = {}));
/** @typedef {number} */
export var DocumentTermMode;
(function (DocumentTermMode) {
    DocumentTermMode[DocumentTermMode["All"] = 1] = "All"
    DocumentTermMode[DocumentTermMode["Any"] = 2] = "Any"
})(DocumentTermMode || (DocumentTermMode = {}));
export class DocumentSearchRequest {
    /** @param {{searchTerms?:string,searchMode?:DocumentSearchMode,termMode?:DocumentTermMode,userId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    searchTerms;
    /** @type {DocumentSearchMode} */
    searchMode;
    /** @type {DocumentTermMode} */
    termMode;
    /** @type {string} */
    userId;
}

JavaScript DocumentSearchRequest DTOs

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

HTTP + JSV

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

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

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DocumentSearchCount: 0,
	DocumentSearchResults: 
	[
		{
			AttachmentId: 00000000000000000000000000000000,
			DateAdded: 0001-01-01,
			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
		}
	}
}