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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LineSearchResult:
    line_text: Optional[str] = None
    page_no: int = 0
    page_line_no: int = 0
    doc_line_no: int = 0
    box_top: float = 0.0
    box_left: float = 0.0
    box_width: float = 0.0
    box_height: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentSearchResult:
    attachment_id: Optional[str] = None
    date_added: datetime.datetime = datetime.datetime(1, 1, 1)
    attachment_name: Optional[str] = None
    description: Optional[str] = None
    document_type: Optional[str] = None
    document_group: Optional[str] = None
    dropbox_table_name: Optional[str] = None
    dropbox_record_id: int = 0
    attachment_table_name: Optional[str] = None
    attachment_field_name: Optional[str] = None
    attachment_record_id: int = 0
    file_path: Optional[str] = None
    ocr_source: Optional[str] = None
    ocr_result: Optional[str] = None
    lines: List[LineSearchResult] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentSearchResponse:
    document_search_count: int = 0
    document_search_results: List[DocumentSearchResult] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


class DocumentSearchMode(IntEnum):
    EXACT = 1
    CONTAINS = 2
    STARTS_WITH = 3
    ENDS_WITH = 4


class DocumentTermMode(IntEnum):
    ALL = 1
    ANY = 2


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentSearchRequest:
    search_terms: Optional[str] = None
    search_mode: Optional[DocumentSearchMode] = None
    term_mode: Optional[DocumentTermMode] = None
    user_id: Optional[str] = None

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