POST api/StorageObject/DeleteDocument

Deletes the document completely

Request Information

URI Parameters

None.

Body Parameters

DeleteDocumentExtRequest
NameDescriptionTypeAdditional 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:
<DeleteDocumentExtRequest 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>
  <SystemId>2</SystemId>
  <UserGpid>sample string 1</UserGpid>
  <docId>3</docId>
  <guid>sample string 4</guid>
</DeleteDocumentExtRequest>

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

multipart/form-data

Sample:

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

application/octet-stream

Sample:

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

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>