| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/DocumentSearch |
|---|
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type LineSearchResult() =
member val LineText:String = null with get,set
member val PageNo:Int32 = new Int32() with get,set
member val PageLineNo:Int32 = new Int32() with get,set
member val DocLineNo:Int32 = new Int32() with get,set
member val BoxTop:Double = new Double() with get,set
member val BoxLeft:Double = new Double() with get,set
member val BoxWidth:Double = new Double() with get,set
member val BoxHeight:Double = new Double() with get,set
[<AllowNullLiteral>]
type DocumentSearchResult() =
member val AttachmentId:Guid = new Guid() with get,set
member val DateAdded:DateTime = new DateTime() with get,set
member val AttachmentName:String = null with get,set
member val Description:String = null with get,set
member val DocumentType:String = null with get,set
member val DocumentGroup:String = null with get,set
member val DropboxTableName:String = null with get,set
member val DropboxRecordId:Int32 = new Int32() with get,set
member val AttachmentTableName:String = null with get,set
member val AttachmentFieldName:String = null with get,set
member val AttachmentRecordId:Int32 = new Int32() with get,set
member val FilePath:String = null with get,set
member val OCRSource:String = null with get,set
member val OCRResult:String = null with get,set
member val Lines:ResizeArray<LineSearchResult> = new ResizeArray<LineSearchResult>() with get,set
[<AllowNullLiteral>]
type DocumentSearchResponse() =
member val DocumentSearchCount:Int32 = new Int32() with get,set
member val DocumentSearchResults:ResizeArray<DocumentSearchResult> = new ResizeArray<DocumentSearchResult>() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
type DocumentSearchMode =
| Exact = 1
| Contains = 2
| StartsWith = 3
| EndsWith = 4
type DocumentTermMode =
| All = 1
| Any = 2
[<AllowNullLiteral>]
type DocumentSearchRequest() =
member val searchTerms:String = null with get,set
member val searchMode:DocumentSearchMode = new DocumentSearchMode() with get,set
member val termMode:DocumentTermMode = new DocumentTermMode() with get,set
member val userId:Guid = new Guid() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}