CancelLocation

Detaches a device from the Verizon network.

Uses and Requirements

NOTE: This API is currently in a limited Beta trial. Due to strict network limitations it is not available for general use. It might be enabled for a broader audience in the future.

You can use this API for plan changes, when devices must download appropriate policies or settings to adjust the streaming speed.

Note the limitations on calls to this API:

For Example, the API invocation is limited to 40 per hour (for both customer A and customer B). Any additional calls are queued for the next hour. So if customer A sends 100 calls, the 100th call will be processed and an eventual callback will be sent back to the customer in the third hour from the time the request was made.

Request Parameters

Parameter Type Description
AccountName
optional		 string

The name of a billing account. An account name is usually numeric, and must include any leading zeros.
DeviceList
optional		 DeviceIdentifierCollection

A list of the devices that you want to detach from the network, specified by device identifier.

You can use GetDeviceList to get a list of all devices in the account.

For each device in DeviceList, use this structure of nested parameters: 

            <DeviceIdentifierCollection>
              <DeviceIndentifiers>
                <DeviceIdentifier>
                  <Kind></Kind>
                  <Identifier></Identifier>
                </DeviceIdentifier>
              </DeviceIndentifiers>
            </DeviceIdentifierCollection>
Kind
required for DeviceList		 string The type of the device identifier. Valid types of identifiers are:

  • IMEI - decimal, up to 16 digits
  • ICCID (up to 20 digits)
  • MDN - decimal, 10 digits
  • MIN
  • IMSI
  • MSISDN
  • EID
Identifier
required for DeviceList		 string The value of the device identifier.

Response Parameters

Parameter Type Description
RequestId string

A unique string that associates the request with the results that are sent via a callback service.

The ThingSpace Platform will send a separate callback message for each device that matched the request criteria, indicating whether the operation succeeded for that device and containing any requested information. All of the callback messages will have the same RequestId.

Callback Response Parameters

Parameter Type Description
CallbackRequest CallbackRequest Wrapper element for all callback elements.
Username string The username defined when a URL was registered for the callback service, or an empty element if no username was defined.
Password string The password defined when a registered for the callback service, or an empty element if no password was defined.
RequestId string A unique string that matches the RequestId returned in the synchronous response to the original API request.

A separate callback message is sent for each device that matched the request criteria, indicating whether the operation succeeded for that device. All of the callback messages will have the same RequestId.
Data CallbackData The data elements for this callback.
CarrierService CarrierServiceCallbackRequest The data returned from a CarrierService API request.
ChangeDeviceState ChangeDeviceStateResponse Null for CancelLocation requests.
ChangeDeviceFeatureCodes ChangeDevicefeatureCodesResponse Null for CancelLocation requests.
ChangeDeviceServicePlan ChangeDeviceServicePlanResponse Null for CancelLocation requests.
ChangeDeviceCostCenter ChangeDeviceCostCenter Response Null for CancelLocation requests.
ChangeDeviceCustomFields ChangeDeviceCustomFieldsResponse Null for CancelLocation requests.
ChangeDeviceIdentifier ChangeDeviceIdentifierResponse Null for CancelLocation requests.
Change4GDeviceIdentifier Change4GDeviceIdentifierResponse Null for CancelLocation requests.
MoveDevice MoveDeviceResponse Null for CancelLocation requests.
ChangeDeviceContactInfo ChangeDeviceContactInfoResponse Null for CancelLocation requests.
ChangeDeviceSkuSubscription ChangeDeviceSkuSubscriptionResponse Null for CancelLocationRequest requests.
SetUsageSegmentationLabels SetUsageSegmentationLabelsResponse Null for CancelLocationRequestResponse
CancelLocation CancelLocationRequestResponse Information about the CancelLocation request.
Device DeviceIdentifier The device that was changed.
Kind string The type of the device identifier. Valid types of identifiers are:
  • ICCID (up to 20 digits)
  • IMEI (up to 16 digits)
  • MDN
  • MEID (hexadecimal)
  • MIN
  • MSISDN
  • EID>
Identifier string The value of the device identifier.
ExternalProvisioningChange ExternalProvisioningChange Null for CancelLocation requests.
PromoChange PromoChange Null for this callback service.
SMSDelivery SMSDelivery Null for this callback service.
PRLInformation PRLInformation Null for this callback service.
DeviceService DeviceService Null for this callback service.
GoToState GoToState Null for this callback service.
DeviceProfileService DeviceProfileService Null for this callback service.
AlertService AlertService Null for this callback service.
InternalServivce InternalServivce Null for this callback service.
DiagnosticsService DiagnosticsService Null for this callback service.
Fault SoapFault Information about any errors that may have occurred.
Comment Comment Null for this callback service.
Status string The status of detach request. Valid values include:
  • Success (requeust is queued to be sent)
  • Failed
CallbackCount integer The number of times this callback message has been sent.
MaxCallbackThreshold integer The maximum number of times this callback message will be sent if it is not correctly acknowledged.
ExtendedEnhancedConnectivityService ExtendedEnhancedConnectivityService Null for this callback service.
NiddService NiddService Null for this callback service.

Example SOAP Request 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://nphase.com/unifiedwebservice/v2"
xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.CarrierService"
xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
<soapenv:Header>
    <token xmlns="http://nphase.com/unifiedwebservice/v2">7a917d19-92d3-4f4f-a295-50b34b137ec5
 <soapenv:Body>
    <v2:CancelLocation>
       <!--Optional:-->
       <v2:Input>
          <nph:AccountName>4gpublicaccount<nph:AccountName>
          <!--Optional:-->
          <nph:DeviceList>
             <!--Zero or more repetitions:-->
             <nph1:DeviceIdentifierCollection>
                <!--Optional:-->
                <nph1:DeviceIdentifiers>
                   <!--Zero or more repetitions:-->
                   <nph1:DeviceIdentifier>
                     <nph1:Kind>iccid</nph1:Kind>
                      <nph1:Identifier>11245083754863613112</nph1:Identifier>
                   </nph1:DeviceIdentifier>
                </nph1:DeviceIdentifiers>
                <!--Optional:-->
             </nph1:DeviceIdentifierCollection>
          </nph:DeviceList>
       </v2:Input>
    </v2:CancelLocation>
 </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response 

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <CancelLocationResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.CarrierService">
       <a:RequestId>508b2107-a301-4da9-921e-f23320fb6c3a</a:RequestId>
      </Output>
    </CancelLocationResponse>
  </s:Body>
</s:Envelope>

Example SOAP Callback 

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <CallbackRequest xmlns="http://nphase.com/unifiedwebservice/v2">
            <Username>test</Username>
            <Password>test</Password>
            <RequestId>508b2107-a301-4da9-921e-f23320fb6c3a</RequestId>
            <Data>
                <Data>
                    <CarrierService>
                        <ChangeDeviceState xsi:nil="true"/>
                        <ChangeDeviceFeatureCodes xsi:nil="true"/>
                        <ChangeDeviceServicePlan xsi:nil="true"/>
                        <ChangeDeviceCostCenter xsi:nil="true"/>
                        <ChangeDeviceCustomFields xsi:nil="true"/>
                        <ChangeDeviceIdentifier xsi:nil="true"/>
                        <Change4GDeviceIdentifier xsi:nil="true"/>
                        <MoveDevice xsi:nil="true"/>
                        <ChangeDeviceContactInfo xsi:nil="true"/>
                        <ChangeDeviceSkuSubscription xsi:nil="true"/>
                        <SetUsageSegmentationLabels xsi:nil="true"/>
                        <CancelLocation>
                            <AccountName>4gpubicaccount</AccountName>
                            <DeviceIdentifierCollection>
                                <Kind>iccid</Kind>
                                <Identifier>11245083754863613112</Identifier>
                            </DeviceIdentifierCollection>
                        </CancelLocation>
                    </CarrierService>
                    <ExternalProvisioningChange xsi:nil="true"/>
                    <PromoChange xsi:nil="true"/>
                    <SMSDelivery xsi:nil="true"/>
                    <PRLInformation xsi:nil="true"/>
                    <DeviceService xsi:nil="true"/>
                    <GoToState xsi:nil="true"/>
                    <DeviceProfileService xsi:nil="true"/>
                    <AlertService xsi:nil="true"/>
                    <InternalService xsi:nil="true"/>
                    <DiagnosticsService xsi:nil="true"/>
                    <Fault xsi:nil="true"/>
                    <Comment xsi:nil="true"/>
                    <Summary xsi:nil="true"/>
                    <Status>SUCCESS</Status>
                    <CallbackCount>1</CallbackCount>
                    <MaxCallbackThreshold>4</MaxCallbackThreshold>
                    <ExtendedEnhancedConnectivityService xsi:nil="true"/>
                    <NiddService xsi:nil="true"/>
                </Data>
            </Data>
        </CallbackRequest>
    </s:Body>
</s:Envelope>

Example Failure Callback

  <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
            <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                <CallbackRequest xmlns="http://nphase.com/unifiedwebservice/v2">
                    <Username>test</Username>
                    <Password>test</Password>
                    <RequestId>E1549153-D609-46AD-9CFC-8D9CEB1A1141</RequestId>
                    <Data>
                        <Data>
                            <CarrierService xsi:nil="true"/>
                            <ExternalProvisioningChange xsi:nil="true"/>
                            <PromoChange xsi:nil="true"/>
                            <SMSDelivery xsi:nil="true"/>
                            <PRLInformation xsi:nil="true"/>
                            <DeviceService xsi:nil="true"/>
                            <GoToState xsi:nil="true"/>
                            <DeviceProfileService xsi:nil="true"/>
                            <AlertService xsi:nil="true"/>
                            <InternalService xsi:nil="true"/>
                            <DiagnosticsService xsi:nil="true"/>
                            <Fault>
                                <q1:faultcode xmlns:q1="http://nphase.com/unifiedwebservice/v2" xmlns="">UnifiedWebService.DEVICE_NOT_FOUND</q1:faultcode>
                                <faultstring>Device Not Found for the given identifier(s)</faultstring>
                            </Fault>
                            <Comment xsi:nil="true"/>
                            <Summary xsi:nil="true"/>
                            <Status>Failed</Status>
                            <CallbackCount>1</CallbackCount>
                            <MaxCallbackThreshold>4</MaxCallbackThreshold>
                            <ExtendedEnhancedConnectivityService xsi:nil="true"/>
                            <NiddService xsi:nil="true"/>
                        </Data>
                    </Data>
                </CallbackRequest>
            </s:Body>
        </s:Envelope>