removeConsignmentsFromGroup

This method removes a manifest group code from an array of consignments.

Note

It is assumed that you have worked through Creating your first Request to a Service and are familiar with the Properties needed to Call or Create a Consignment and addConsignmentsToGroup.

How to submit a request

Proceed as follows:

  1. If you have not already done so, open a new project using the WSDL ConsignmentService.xml.

  2. Create a new request under removeConsignmentsFromGroup,

  3. Enter the authorisation for the request.

  4. Specify the following:

    1. The code(s) of the existing consignment(s).

    2. The manifest group code to be removed.

  5. Click Arrow.png to submit the request.

Example Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="urn:DeliveryManager/services">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:removeConsignmentsFromGroup soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <consignmentCodes xsi:type="ser:ArrayOf_soapenc_string" soapenc:arrayType="soapenc:string[]" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <item>DMC4BY1V48XK</item>
            <item>DMC4BY1V4DGT</item>
      </consignmentCodes>
      </ser:removeConsignmentsFromGroup>
   </soapenv:Body>
</soapenv:Envelope>

If the input is valid, then the consignments are removed from the manifest group, and true is returned, as in the example below.

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <ns1:removeConsignmentsFromGroupResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <removeConsignmentsFromGroupReturn xsi:type="xsd:boolean">true</removeConsignmentsFromGroupReturn>
      </ns1:removeConsignmentsFromGroupResponse>
   </soapenv:Body>
</soapenv:Envelope>

Next Steps

If you wish to confirm the removal, then, in the GUI, go to the bottom left of the Advanced tab for one of the consignments and verify that the Manifest Group Code field is now empty.