POST api/StorageObject/SearchDocuments

searches document based on the search criteria provided

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SearchdocumentRequest		SearchDocumentRequest	None.
Guid		string	None.
Vendor_Name	Vendor name in caps.	string	Required
Vendor_UserID	User ID of Vendor service account.	string	Required
Vendor_Password	Encrypted Password of vendor service account	string	Required

Request Formats

application/json, text/json, text/html

Sample:

{
  "SearchdocumentRequest": {
    "SystemId": 1,
    "UserGpid": "sample string 2",
    "BusinessAreaId": 3,
    "SearchFields": null,
    "PageNum": 4,
    "RecordLimit": 5,
    "DocumentClass": "sample string 6"
  },
  "Guid": "sample string 1",
  "Vendor_Name": "sample string 2",
  "Vendor_UserID": "sample string 3",
  "Vendor_Password": "sample string 4"
}

application/xml, text/xml

Sample:

<SearchDocExtRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.ExtGateway.Models">
  <Vendor_Name>sample string 2</Vendor_Name>
  <Vendor_Password>sample string 4</Vendor_Password>
  <Vendor_UserID>sample string 3</Vendor_UserID>
  <Guid>sample string 1</Guid>
  <SearchdocumentRequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.Gateway.EntityDataModels">
    <d2p1:BusinessAreaId>3</d2p1:BusinessAreaId>
    <d2p1:DocumentClass>sample string 6</d2p1:DocumentClass>
    <d2p1:PageNum>4</d2p1:PageNum>
    <d2p1:RecordLimit>5</d2p1:RecordLimit>
    <d2p1:SearchFields i:nil="true" />
    <d2p1:SystemId>1</d2p1:SystemId>
    <d2p1:UserGpid>sample string 2</d2p1:UserGpid>
  </SearchdocumentRequest>
</SearchDocExtRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SearchDocExtRequest'.

multipart/form-data

Sample:

Failed to generate the sample for media type 'multipart/form-data'. Cannot use formatter 'DocumentCreationFormatter' to write type 'SearchDocExtRequest'.

application/octet-stream

Sample:

Failed to generate the sample for media type 'application/octet-stream'. Cannot use formatter 'DocumentCreationFormatter' to write type 'SearchDocExtRequest'.

Response Information

Resource Description

PagedResultOfSearchDocumentResultDto

Name	Type	Additional information
Results	SearchDocumentResultDto	None.
CurrentPage	integer	None.
PageCount	integer	None.
PageSize	integer	None.
RowCount	integer	None.
HasMoreItems	boolean	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Results": {
    "DocumentMetaDataList": [
      {
        "sample string 1": {},
        "sample string 3": {}
      },
      {
        "sample string 1": {},
        "sample string 3": {}
      }
    ]
  },
  "CurrentPage": 1,
  "PageCount": 1,
  "PageSize": 1,
  "RowCount": 1,
  "HasMoreItems": true
}

application/xml, text/xml

Sample:

<PagedResultOfSearchDocumentResultDtoe1mIEzo6 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.Gateway.EntityDataModels">
  <CurrentPage>1</CurrentPage>
  <HasMoreItems>true</HasMoreItems>
  <PageCount>1</PageCount>
  <PageSize>1</PageSize>
  <Results>
    <DocumentMetaDataList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringanyType>
        <d3p1:KeyValueOfstringanyType>
          <d3p1:Key>sample string 1</d3p1:Key>
          <d3p1:Value />
        </d3p1:KeyValueOfstringanyType>
        <d3p1:KeyValueOfstringanyType>
          <d3p1:Key>sample string 3</d3p1:Key>
          <d3p1:Value />
        </d3p1:KeyValueOfstringanyType>
      </d3p1:ArrayOfKeyValueOfstringanyType>
      <d3p1:ArrayOfKeyValueOfstringanyType>
        <d3p1:KeyValueOfstringanyType>
          <d3p1:Key>sample string 1</d3p1:Key>
          <d3p1:Value />
        </d3p1:KeyValueOfstringanyType>
        <d3p1:KeyValueOfstringanyType>
          <d3p1:Key>sample string 3</d3p1:Key>
          <d3p1:Value />
        </d3p1:KeyValueOfstringanyType>
      </d3p1:ArrayOfKeyValueOfstringanyType>
    </DocumentMetaDataList>
  </Results>
  <RowCount>1</RowCount>
</PagedResultOfSearchDocumentResultDtoe1mIEzo6>