Cancellations

This section details cancellations methods available within SIMPro.

cancelSIM method

This method is used to cancel SIMs which are in or out of contract. If there is a cost associated with the cancellation then this can be pre-approved – this means that the cost of the cancellation will be accepted and the cancellation should go ahead. See below for methods to getting a quote before cancellations the SIMs.

The request for the cancelSIMs require the following parameters:

Name	Description	Type	Example
Item	CancellationItem Type	array	n/a
preApproved	Set to true when fees should be approved automatically – if you enter false or omit this parameter and the cancellation would incur a cost the cancellation request will be rejected	Boolean	true

The CancellationItem type contains the following

Name	Description	Type	Example
Identifier	The identifier (ICCID) of the SIM	string	894000000000000000
cancellationDate	The date the SIM is to be cancelled, this must be at least tomorrow – we are unable to cancel SIMs today.	Date (YYYYMM-DD)	2015-05-01
enableFullBar	Whether a full bar should be applied to the SIM	boolean	true

The response to a cancelSIMs request will contain the following parameters

Name	Description	Type	Example
return	A request number	integer	9999

Sample request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://simprov4.wirelesslogic.com/api/">
    <soapenv:Body>
        <api:cancelSIMs>
            <cancelSIMsRequest>
                <items>
                <item>
                     <identifier>894000000000000000</identifier>
                     <cancellationDate>2015-05-01</cancellationDate>
                     <enableFullBar>true</enableFullBar>
                </item>
            </items>
                     <preapproved>false</preapproved>
         </cancelSIMsRequest>
      </api:cancelSIMs>
   </soapenv:Body>
</soapenv:Envelope>

getCancellationQuote Method

 This method is used to generate a cancellation quote for SIMs which are in or out of contract. The response contains a reference which can be used to later request actual cancellation of the associated SIMs

• In contract sim - more than 30 days left on their contract
• Out of contract sim - the contract had expired or in its last month of line rental

For the cancellation request to begin, call the getCancellationQuoteRequest which
returns getCancellationQuoteResponse. If there any issues with the SIM or
cancellation date then an SOAP Fault is returned. The SIM can be barred by setting
the enableFullBar to true.

The CancellationQuoteRequest type contains the following:

Name	Description	Type	Example
Item	Array of CancellationItem	array	N/A

The CancellationItem type contains the following

Name	Description	Type	Example
identifier	The identifier (ICCID) of the SIM	string	894000000000000000
cancellation Date	The date the SIM is to be cancelled, this must be at least tomorrow – we are unable to cancel SIMs today	Date (YYYYMM-DD)	2015-05-01
enableFullBar	Whether a full bar should be applied to the SIM	boolean	false

The GetCancellationQuoteResponse type contains the following:

Name	Description	Type	Example
quote	The quote object	array	N/A

The CancellationQuote type contains the following

Name	Description	Type	Example
id	The unique id of the quote	int	1
items	The CancellationQuoteItem details	array	N/A
inContractFee	Total fee of SIMs in contract	float	1.2
outOfContractFee	Total fee of SIMs out of contract	float	2.1
adminFees	Total of admin fees	float	1.2
totalFees	Total fee - all together	float	1.2
timeStamp	The date the quote was created	date	2015-05-01

The CancellationQuoteItem type contains the following

Name	Description	Type	Example
Identifier	The identifier (ICCID) of the SIM	string	894000000000000000
inContract	True if the SIM is still in contract	boolean	true
adminFee	Administration fee	float	1.9
buyOutFee	Buyout fee for in contract SIMs	float	1.9
cancellationDate	Date the SIM will be cancelled	date	2015-05-01
enableFullBar	True if full bar is applied to the SIM	boolean	N/A

The CancellationQuote contains a unique ID which is used as a reference as part of another request (cancelSIMsByQuoteReference) to ensure the cancellation occurs.

The quote is only valid until the end of the day the quote is generated.

Sample request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://simprov4.wirelesslogic.com/api/">
<soapenv:Body>
<api:getCancellationQuote>
<getCancellationQuoteRequest>
<items>
<item>
<identifier>89443011313244707250</identifier>
<cancellationDate>2014-11-06</cancellationDate>
<enableFullBar>true</enableFullBar>
</item>
</items>
</getCancellationQuoteRequest>
</api:getCancellationQuote>
</soapenv:Body>
</soapenv:Envelope>

Sample respo

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://simprov4.wirelesslogic.com/api/">
<soapenv:Body>
<api:getCancellationQuoteResponse>
<return>
<quote>
<id>123</id>
<items>
<item>
<identifier>89443011313244707250</identifier>
<inContract>false</inContract>
<adminFee>10</adminFee>
<buyOutFee>0</buyOutFee>
<cancellationDate>2015-06-01</cancellationDate>
<enableFullBar>true</enableFullBar>
</item>
<item>
<identifier>89443011313244707251</identifier>
<inContract>false</inContract>
<adminFee>10</adminFee>
<buyOutFee>0</buyOutFee>
<cancellationDate>2015-06-01</cancellationDate>
<enableFullBar>true</enableFullBar>
</item>
<item>
<identifier>89443011313244707252</identifier>
<inContract>true</inContract>
<adminFee>10</adminFee>
<buyOutFee>20</buyOutFee>
<cancellationDate>2015-06-01</cancellationDate>
<enableFullBar>true</enableFullBar>
</item>
</items>
<inContractFee>20</inContractFee>
<outOfContractFee>0</outOfContractFee>
<adminFees>30</adminFees>
<totalFees>50</totalFees>
<timeStamp>2015-04-30</timeStamp>
</quote>
</return>
</api:getCancellationQuoteResponse>
</soapenv:Body>
</soapenv:Envelope>

cancelSIMsByQuoteId API

The cancelSIMsByQuoteId method is used to cancel sims based on a quote id generated using the getCancellationQuote method.

The request for the cancelSIMsByQuoteId method requires the following parameters.

Name	Description	Type	Example
id	A quote id returned by getCancellationQuote	int	123

The response to a cancelSIMsByQuoteId request will contain the following parameters:

Name	Description	Type	Example
return	A request number	int	9999

If a quote cannot be found then an SOAP Fault is returned.

Sample request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://simprov4.wirelesslogic.com/api/">
<soapenv:Body>
<v3:cancelSIMsByQuoteId>
<id>123</id>
</v3:cancelSIMsByQuoteId>
</soapenv:Body>
</soapenv:Envelope>