Modify Delivery

ModifyDeliveryResponse modifyDelivery(ModifyDeliveryRequest request)

Elements of ModifyDeliveryRequest:

• deliveryId: The delivery Id to modify. Returned from createDelivery.
• vehicleIds: Zero or more vehicles to send the file to. At least one vehicleId or groupName is required.
• groupNames: Zero or more groups to send the file to. At least one vehicleId or groupName is required.
• sender: who is sending the file. Required.
• subject: The subject of the delivery. Required.
• deliveryOption: One of WIFI, TERR or SCHEDULE
  • WIFI: Delivery will only be delivered when WiFi is available
  • TERR: Delivery will be delivered by any means possible.
  • SCHEDULE: Delivery will be delivered according to a schedule. Try Wifi for some interval, then deliver via any means possible.
• deliverySchedule: The period of time to wait before trying to deliver via terrestrial. Required when deliveryOption = SCHEDULE
  • interval: The number of units to wait.
  • units: Which units to specify the interval. One of: MINUTES, HOURS, DAYS
• expireDateTime: If specified, when the file should be removed from the vehicles.
• availableDateTime: If specified, when the file should be visible to the end user. The file is still sent immediately, it will not be visible until the specified time. If not specified, the file will be available as soon as it is delivered.
• description: An optional description of the delivery.

 

Sample XML Request

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

<SOAP-ENV:Body>
  <ns2:modifyDeliveryRequest xmlns:ns2="http://www.qualcomm.com/mms">
    <ns2:id>2001</ns2:id>
    <ns2:vehicleIds>FakeMCP200001</ns2:vehicleIds>
    <ns2:vehicleIds>FakeMCP200002</ns2:vehicleIds>
    <ns2:sender>test sender2</ns2:sender>
    <ns2:subject>test banner2</ns2:subject>
    <ns2:deliveryOption>WIFI</ns2:deliveryOption>
    <ns2:expireDateTime>2011-10-01T18:17:46.474Z</ns2:expireDateTime>
    <ns2:availableDateTime>2011-09-30T18:17:46.469Z</ns2:availableDateTime>
    <ns2:description>test descr</ns2:description>
    <ns2:sendImmediately>false</ns2:sendImmediately>
    <ns2:groupNames>WEBTEST GROUP</ns2:groupNames>
    <ns2:groupNames>WEBTEST GROUP2</ns2:groupNames>
  </ns2:modifyDeliveryRequest>
</SOAP-ENV:Body>

 

Sample XML Response

The response will contain information about the delivery.

Success Response

<SOAP-ENV:Body>
  <ns2:modifyDeliveryResponse xmlns:ns2="http://www.qualcomm.com/mms">
    <ns2:deliveryId>2001</ns2:deliveryId>
    <ns2:deliveryStatuses>
      <ns2:statusType>SUCCESS</ns2:statusType>
      <ns2:code>mms.ws.modifydelivery.success</ns2:code>
      <ns2:reason/></ns2:deliveryStatuses>
    </ns2:modifyDeliveryResponse>
</SOAP-ENV:Body>

 

Sample Failed Response

<SOAP-ENV:Body>
  <ns2:modifyDeliveryResponse xmlns:ns2="http://www.qualcomm.com/mms">
    <ns2:deliveryId>-1</ns2:deliveryId>
    <ns2:deliveryStatuses>
      <ns2:statusType>ERROR</ns2:statusType>
      <ns2:code>error.reason.request.description.length</ns2:code>
      <ns2:reason>Description exceeds allowed characters limit of 255</ns2:reason>
    </ns2:deliveryStatuses>
    <ns2:deliveryStatuses>
      <ns2:statusType>ERROR</ns2:statusType>
      <ns2:code>error.reason.request.sender.length</ns2:code>
      <ns2:reason>Sender allowed characters limit of 80</ns2:reason>
    </ns2:deliveryStatuses>
    <ns2:deliveryStatuses>
      <ns2:statusType>ERROR</ns2:statusType>
      <ns2:code>error.reason.request.banner.length</ns2:code>
      <ns2:reason>Subject exceeds allowed characters limit of 10</ns2:reason>
    </ns2:deliveryStatuses>
  </ns2:modifyDeliveryResponse>
</SOAP-ENV:Body>

 

Sample Exception Response

<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>