Delete Delivery

Last updated
Save as PDF

deleteDelivery

Deletes an existing delivery. This method will first check if the delivery exists and has been sent. If the delivery has been sent, it will be processed so that the file will be removed from all the vehicles associated with this delivery.

DeleteDeliveryResponse deleteDelivery(DeleteDeliveryRequest deliveryId)

deliveryId: The id of the delivery that was created earlier.

Sample XML Request

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

<SOAP-ENV:Body>
   <ns2:deleteDeliveryRequest xmlns:ns2="http://www.qualcomm.com/mms">2004</ns2:deleteDeliveryRequest>
</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 Errors

If there are errors encountered during the delete process they will be returned in the response.

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

Sample XML Fault

If an error occurs while trying to locate the delivery to delete, a soap fault will be returned.

<SOAP-ENV:Body>
  <SOAP-ENV:Fault>
    <faultcode>SOAP-ENV:Server</faultcode>
    <faultstring xml:lang="en">error.result.request - Unable to locate delivery</faultstring>
  </SOAP-ENV:Fault>
</SOAP-ENV:Body>