Skip to main content
Omnitracs Knowledge Base

Delete File

deleteFile

This method will remove the file from all vehicles as well as from the MMS application. It will no longer be available to send to vehicles.
All delivery requests , new or pending, associated with this content, will be removed prior to deletion of the content.

 

void deleteFile(DeleteFileRequest filename)

  • filename: The original name of the file to delete.

 

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
 

<SOAP-ENV:Body>
  <ns2:deleteFileRequest xmlns:ns2="http://www.qualcomm.com/mms">test.pdf</ns2:deleteFileRequest>
</SOAP-ENV:Body>

 

Sample XML Response  

​​​<SOAP-ENV:Body>
  <ns2:deleteDeliveryResponse xmlns:ns2="http://www.qualcomm.com/mms">
    <ns2:deleteStatus>
      <ns2:statusType>SUCCESS</ns2:statusType>
      <ns2:code>mms.ws.deletedelivery.success</ns2:code>
      <ns2:reason>Delete Delivery succeeded. The delivery has not been sent to devices yet.</ns2:reason>
    </ns2:deleteStatus>
  </ns2:deleteDeliveryResponse>
</SOAP-ENV:Body>
 
 

Sample XML Response with Error  

<SOAP-ENV:Body>
  <ns2:deleteFileResponse xmlns:ns2="http://www.qualcomm.com/mms">
    <ns2:deleteStatus>
      <ns2:statusType>ERROR</ns2:statusType>
      <ns2:code>error.reason.request.file.invalid </ns2:code>
      <ns2:reason>File not found.</ns2:reason>
    </ns2:deleteStatus>
  </ns2:deleteFileResponse>
</SOAP-ENV:Body>

 

Errors
 

Error Code

Description

Remarks

error.reason.request.nofile

No file was provided in this delete request

The fileName is required for deleteFile.

error.reason.request.file.invalid

File not found

The provided fileName was not found.

mms.ws.deletefile.error

An error was encountered while processing the delete request.

See the deleteErrors for details

 

 

  • Was this article helpful?