debugConsignmentWhyNotWithBookingCode

This method returns, for any given consignment and booking code, the carrier services that cannot be selected for allocation, and the reasons.

Tip

If you need to modify your carrier services after using this method, refer to Configuring your Carrier Services. Likewise, if you need to modify your carrier 'service groups' after using the method, refer to Creating your Carrier 'Service Groups'.

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 Booking Codes and the Allocation Filter.

How to submit a request

Proceed as follows:

If you have not already done so, open a new project using the WSDL DebugService.xml.
Create a new request under debugConsignmentWhyNotWithBookingCode,
Enter the authorisation for the request.
Specify the required bookingCode.
Click to submit the request. If any carrier services are not available, then they are returned in the debugConsignmentWhyNotReturn array (refer to the Example Response below).

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:debugConsignmentWhyNotWithBookingCode soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
        <consignmentCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DMC4BY1U60TX</consignmentCode>
        <bookingCode xsi:type="soapenc:string">@48</bookingCode>
      </ser:debugConsignmentWhyNotWithBookingCode>
   </soapenv:Body>
</soapenv:Envelope>

For an example response, see 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:debugConsignmentWhyNotWithBookingCodeResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <debugConsignmentWhyNotWithBookingCodeReturn soapenc:arrayType="soapenc:string[5]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <debugConsignmentWhyNotWithBookingCodeReturn xsi:type="soapenc:string">DPD07NEXTDAY cannot be used as it is not in the set of acceptable carrier service group codes</debugConsignmentWhyNotWithBookingCodeReturn>
            <debugConsignmentWhyNotWithBookingCodeReturn xsi:type="soapenc:string">DPD07REVERSEND cannot be used as it is not in the set of acceptable carrier service group codes</debugConsignmentWhyNotWithBookingCodeReturn>
            <debugConsignmentWhyNotWithBookingCodeReturn xsi:type="soapenc:string">HERM48 cannot be used as there is a parcel where the dimensions PF_GIRTH  (PF_GIRTH=(D1+D2)*2+D3 where D1&amp;#60;D2&amp;#60;D3) is too long</debugConsignmentWhyNotWithBookingCodeReturn>
            <debugConsignmentWhyNotWithBookingCodeReturn xsi:type="soapenc:string">HERMNONSIG48 cannot be used as there is a parcel where the dimensions PF_GIRTH  (PF_GIRTH=(D1+D2)*2+D3 where D1&amp;#60;D2&amp;#60;D3) is too long</debugConsignmentWhyNotWithBookingCodeReturn>
            <debugConsignmentWhyNotWithBookingCodeReturn xsi:type="soapenc:string">HERMNDG cannot be used as there is a parcel where the dimensions PF_GIRTH  (PF_GIRTH=(D1+D2)*2+D3 where D1&amp;#60;D2&amp;#60;D3) is too long</debugConsignmentWhyNotWithBookingCodeReturn>
         </debugConsignmentWhyNotWithBookingCodeReturn>
      </ns1:debugConsignmentWhyNotWithBookingCodeResponse>
   </soapenv:Body>
</soapenv:Envelope>