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

**DocumentSearchRequest** Parameters:
Name	Parameter	Data Type	Required
searchTerms	body	string	No
searchMode	body	DocumentSearchMode	No
termMode	body	DocumentTermMode	No
userId	body	Guid	No

**DocumentSearchMode** Enum:
Name	Value
Exact	1
Contains	2
StartsWith	3
EndsWith	4

**DocumentTermMode** Enum:
Name	Value
All	1
Any	2

**DocumentSearchResponse** Parameters:
Name	Parameter	Data Type	Required
DocumentSearchCount	form	int	No
DocumentSearchResults	form	List<DocumentSearchResult>	No
ResponseStatus	form	ResponseStatus	No

**DocumentSearchResult** Parameters:
Name	Parameter	Data Type	Required
AttachmentId	form	Guid	No
DateAdded	form	DateTime	No
AttachmentName	form	string	No
Description	form	string	No
DocumentType	form	string	No
DocumentGroup	form	string	No
DropboxTableName	form	string	No
DropboxRecordId	form	int	No
AttachmentTableName	form	string	No
AttachmentFieldName	form	string	No
AttachmentRecordId	form	int	No
FilePath	form	string	No
OCRSource	form	string	No
OCRResult	form	string	No
Lines	form	List<LineSearchResult>	No

**LineSearchResult** Parameters:
Name	Parameter	Data Type	Required
LineText	form	string	No
PageNo	form	int	No
PageLineNo	form	int	No
DocLineNo	form	int	No
BoxTop	form	double	No
BoxLeft	form	double	No
BoxWidth	form	double	No
BoxHeight	form	double	No

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