POST api/StorageObject/GetDocumentWithIndexingFieldValues

Gets the document and its indexing field values

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGPID		string	Required
SystemId		integer	Required
DocID		integer	Required
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:

{
  "UserGPID": "sample string 1",
  "SystemId": 2,
  "DocID": 3,
  "Guid": "sample string 4",
  "Vendor_Name": "sample string 5",
  "Vendor_UserID": "sample string 6",
  "Vendor_Password": "sample string 7"
}

application/xml, text/xml

Sample:

<GetDocWithIndexingFieldValues 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 5</Vendor_Name>
  <Vendor_Password>sample string 7</Vendor_Password>
  <Vendor_UserID>sample string 6</Vendor_UserID>
  <DocID>3</DocID>
  <Guid>sample string 4</Guid>
  <SystemId>2</SystemId>
  <UserGPID>sample string 1</UserGPID>
</GetDocWithIndexingFieldValues>

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 'GetDocWithIndexingFieldValues'.

multipart/form-data

Sample:

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

application/octet-stream

Sample:

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

Response Information

Resource Description

DocumentFieldValues

Name	Description	Type	Additional information
fileOutput		FileOutputInfo	None.
IndexingFields		Collection of Object	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "fileOutput": {
    "FileName": "sample string 1",
    "FilePath": "sample string 2",
    "FileMemoryStream": null,
    "DownloadFileName": "sample string 3"
  },
  "IndexingFields": null
}

application/xml, text/xml

Sample:

<DocumentFieldValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.Gateway.EntityDataModels">
  <IndexingFields i:nil="true" />
  <fileOutput xmlns:d2p1="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.Storage.Gateway.EntityDataModels.Models">
    <d2p1:DownloadFileName>sample string 3</d2p1:DownloadFileName>
    <d2p1:FileMemoryStream xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <d2p1:FileName>sample string 1</d2p1:FileName>
    <d2p1:FilePath>sample string 2</d2p1:FilePath>
  </fileOutput>
</DocumentFieldValues>