POST api/docs/delete?applicationId={applicationId}

A method to delete the uploaded previously customer document by providing the name of the file

Request Information

URI Parameters

Name	Description	Type	Additional information
applicationId	The application id.	integer	Required

Body Parameters

Customer proof document object

ERP.Api.Models.CustomerPortal.CustomerProof

Name	Description	Type	Additional information
Id	Proof id (not used currently)	integer	None.
filename	Name of the uploaded file	string	None.
Status	Status of the document (there is no functionality currently to change the status of the document - so it's defaulted to "Uploaded")	string	None.
DateUploaded	Date and time the proof document was uploaded by the customer	date	None.
Url	The link to API for the document download	string	None.
Type	Type of the proof document	string	None.
Title	Label to display next to the proof document	string	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "filename": "sample string 2",
  "status": "Uploaded",
  "dateUploaded": "2025-01-18",
  "url": "sample string 4",
  "type": "sample string 5",
  "title": "sample string 6"
}

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'Status' in type 'ERP.Api.Models.CustomerPortal.CustomerProof'.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'Status' in type 'ERP.Api.Models.CustomerPortal.CustomerProof'.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'ERP.Api.Models.CustomerPortal.CustomerProof'.

Response Information

Resource Description

Returns 200 status code in case of success, 404 - in case the file doesn't exist on server and couldn't be deleted, 500 - in case of any internal server error

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.