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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<DocumentSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <searchMode>Exact</searchMode>
  <searchTerms>String</searchTerms>
  <termMode>All</termMode>
  <userId>00000000-0000-0000-0000-000000000000</userId>
</DocumentSearchRequest>

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

<DocumentSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DocumentSearchCount>0</DocumentSearchCount>
  <DocumentSearchResults>
    <DocumentSearchResult>
      <AttachmentFieldName>String</AttachmentFieldName>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <AttachmentRecordId>0</AttachmentRecordId>
      <AttachmentTableName>String</AttachmentTableName>
      <DateAdded>0001-01-01T00:00:00</DateAdded>
      <Description>String</Description>
      <DocumentGroup>String</DocumentGroup>
      <DocumentType>String</DocumentType>
      <DropboxRecordId>0</DropboxRecordId>
      <DropboxTableName>String</DropboxTableName>
      <FilePath>String</FilePath>
      <Lines>
        <LineSearchResult>
          <BoxHeight>0</BoxHeight>
          <BoxLeft>0</BoxLeft>
          <BoxTop>0</BoxTop>
          <BoxWidth>0</BoxWidth>
          <DocLineNo>0</DocLineNo>
          <LineText>String</LineText>
          <PageLineNo>0</PageLineNo>
          <PageNo>0</PageNo>
        </LineSearchResult>
      </Lines>
      <OCRResult>String</OCRResult>
      <OCRSource>String</OCRSource>
    </DocumentSearchResult>
  </DocumentSearchResults>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DocumentSearchResponse>