Search

 

IoT Accelerator SOAP API

IoT Accelerator SOAP API

This section describes the SOAP APIs exposed by the IoT Accelerator.

IMPORTANT NOTE:
As part of our continuing efforts to enhance the Aeris IoT Accelerator REST API, we have steadily moved away from the SOAP API technology stack. With many of the SOAP API functionalities now superseded by their REST API equivalents, we encourage you to transition to these REST APIs if you haven't already done so to take full advantage of the enhancements already in place.

Please consider our SOAP APIs as deprecated with no further development or support being done for these.

For each group of APIs, there is a description of the main purposes and then a clickable link which provides details on the structure of the XML request and response. Please note that for testing the APIs you will need to have an active IoT Accelerator account and its associated credentials.

Get to know how to start working with SOAP APIs by reading the dedicated tutorial in the application development section of this site.

IMPORTANT:

As there are slight differences in how the initial Authorization of API is performed in the system for the different groups of APIs , please have a look at the quick start guide to get all the details and understand the differences.

Service portal API

APIs provide functionality within different areas such as solution management, operational status, report, statistics, and support. APIs allow to perform most of the same operations and procedures that can be done via the IoTA Service Portal GUI.

ApiStatus
 
Download WSDL
Echo

With this operation, it is possible to verify that the API is operational by sending a message string to the API and verify that it is returned.

This API will not be replaced with a REST API equivalent.

SubscriptionTraffic
 
Download WSDL
SubscriptionTraffic

This service returns traffic information for resources on the network. The information consists of ID, location update, PDP, and SMS related data.

Use this REST API instead.

UsageDataDownload
 
Download WSDL
UsageDataDownload

This service makes it possible to download usage data (SMS CDR, GPRS CDR, and TAP records) stored in the Data Warehouse.

Use the Business Analytics Report REST API instead

RealtimeTrace
 
Download WSDL
RealtimeTrace

This service makes it possible to trace traffic for a resource in real time.

Use this REST API instead.

OperatorInfo
 
Download WSDL
QueryCountries

With this operation, it is possible to retrieve a list of all available countries with corresponding code.

This API will not be replaced with a REST API equivalent.

QueryOperators

With this operation, it is possible to retrieve a list of all available operators corresponding operator and country codes.

This API will not be replaced with a REST API equivalent.

AggregatedTraffic
 
Download WSDL
AggregatedTraffic

With this operation, it is possible to retrieve traffic aggregated on Total, APN, SMSC Account, CountryCode, Operator, or Opco per current day. The traffic can be filtered to a specific customer.

This API will not be replaced with a REST API equivalent.

AggregatedTraffic_v2

With this operation, it is possible to retrieve traffic aggregated on Total, APN, SMSCAccount, CountryCode, Operator, or Opco per current day. The traffic can be filtered to a specific customer if the user has the required permissions.

Use this REST API instead.

QueryTrafficUsageHistory

With this operation, it is possible to retrieve previously aggregated traffic usage information from a specific time period. The traffic can be filtered on a specific sub-customer if the user has the authority.

This API will not be replaced with a REST API equivalent.

QueryAverageTrafficUsageHistory

With this operation, it is possible to retrieve previously aggregated traffic usage information from a specific time period together with the number of active subscriptions on each required date. The traffic can be filtered on a specific sub-customer if the user has the authority.

This API will not be replaced with a REST API equivalent.

QueryTopSubscriberTrafficUsage

With this operation, it is possible to retrieve the top subscriptions with most traffic usage. The traffic can be filtered on a specific sub-customer if the user has the authority.

Use this REST API instead.

QueryTopCountryTrafficUsage

With this operation, it is possible to retrieve the top countries with most traffic usage. The traffic can be filtered on a specific sub-customer if the user has the authority.

This API will not be replaced with a REST API equivalent.

SubscriptionManagement
 
Download WSDL
QuerySimResource

With this operation, it is possible to retrieve SIM resource information by giving a valid number of IMSI, IMEI, MSISDN, or ICC.

Use this REST API instead.

QuerySimResources

With this operation, it is possible to retrieve information about one or multiple SIM resources by entering a valid IMSI, MSISDN, IMEI, ICC, or customer label, and optionally, a range.

Use this REST API instead.

RequestSubscriptionStatusChange

With this operation, it is possible to request a change on SIM resource subscription status. The request returns a registered serviceRequestId meaning that the actual change can occur at a later time. Use the QuerySubscriptionStatusChange method to check the status of the request.

Use this REST API instead.

QuerySubscriptionStatusChange

With this operation, it is possible to query the status of a requested status change of a SIM subscription.

Use this REST API instead.

QuerySubscriptionsStatusHistory

With this operation, it is possible to retrieve a list of aggregated status volumes for each selected date.

Use this REST API instead.

RequestSubscriptionStatusChangeBatch

With this operation, it is possible to request a change of subscription status using a batch of subscriptions. The batch file can contain up to 10.000 subscriptions and they can belong to different subscription packages. The request returns a registered requestId meaning that the actual change can occur at a later time. This batch operation can only be successful if the operation is successful for every subscription that compounds the batch. Use the QuerySubscriptionChangeBatches and QuerySubscriptionStatusChangeBatch operations to check status of the request.

Use this REST API instead.

QuerySubscriptionStatusChangeBatch

With this operation, it is possible to query the result of the validation part of a requested change of subscription status on a batch of subscriptions.

Use this REST API instead.

RequestSubscriptionPackageChange

With this operation, it is possible to request changing the subscription package for an individual SIM resource or for a range of SIMs. The request returns a registered serviceRequestId meaning that the actual change can occur at a later time.

Use this REST API instead.

RequestSubscriptionPackageChangeBatch

With this operation, it is possible to change the subscription package of a batch of subscriptions. The batch can contain up to 10.000 subscriptions. The operation performs a validation check on the batch. Any subscription failing validation is skipped, and the next subscription is checked. All validation failures are registered. After the validation has finished, the operation returns a registered requestId meaning that the actual change can occur at a later time.

Use this REST API instead.

QuerySubscriptionPackageChangeBatch

With this operation, it is possible to query the validation status of the operation for changing the subscription package of a batch of subscriptions.

Use this REST API instead.

QuerySubscriptionChangeBatches

With this operation, it is possible to query the status of a submitted batch request. Batch requests up to two weeks old are returned unless they have been cleared with the RequestSubscriptionChangeBatchClear method.

Use the new REST API available

RequestSubscriptionChangeBatchClear

With this operation, it is possible to clear submitted batch requests so they are no longer returned by the QuerySubscriptionChangeBatches method in future queries.

This API will not be replaced with a REST API equivalent.

RequestCustomerLabelChange

With this operation, it is possible to request changing a customer label. The request returns a registered serviceRequestId meaning that the actual change can occur at a later time.

Use this REST API instead.

QuerySubscriptionPackages

With this operation, it is possible to retrieve a list of valid subscription packages. It lists only those subscription packages to which subscriptions can be assigned.

Use this REST API instead.

QuerySubscriptionPackages_v2

With this operation, it is possible to retrieve a list of valid subscription packages together with trigger package information. It lists only those subscription packages to which subscriptions can be assigned.

Use this REST API instead.

QueryAllContractSubscriptionPackages

With this operation, it is possible to retrieve a list of all subscription packages together with trigger package information. It also lists those subscription packages to which subscriptions cannot be assigned.

Use this REST API instead.

QuerySubscriptions

With this operation, it is possible to retrieve a collection of subscriptions that match the given search criteria. If no search criterion is given, all of the customers subscriptions are the targets for the search.

Use this REST API instead.

QueryAvailableRegions

With this operation, it is possible to retrieve the available regions for a single subscription.

Use this REST API instead.

ChangeSubscriptionRegion

With this operation, it is possible to change the region for a single subscription.

Use this REST API instead.

ChangeAlternativeRoamingProvider

With this operation, it is possible to change Alternative Roaming Provider (ARP) details for a single subscription. The request returns a registered serviceRequestId, indicating that the actual change can occur at a later time.

Use this REST API instead.

ReportDownload
 
Download WSDL
ReportDownload

With this operation, it is possible to retrieve a list of report data files that can be downloaded.

Use the Business Analytics Report REST API instead

QueryInvoices

With this operation, it is possible to retrieve a list of invoice data files that can be downloaded.

Use the Business Analytics Report REST API instead

DeleteInvoices

With this operation, it is possible to delete an invoice file using its invoiceName.

Use the Business Analytics Report REST API instead

IncidentManagement
 
Download WSDL   
SummaryQuery

With this operation, it is possible to retrieve incidents matching specified conditions.

Use this REST API instead.

Details

With this operation, it is possible to retrieve additional details for a single incident service request.

Use this REST API instead.

LogIncident

With this operation, it is possible to raise an incident request.

Use this REST API instead.

LogIncidentActivity

With this operation, it is possible add an activity to a raised incident.

Use this REST API instead.

QueryCompanySiteDetails

With this operation, it is possible to retrieve available company site details.

Use this REST API instead.

QueryIncidentCategoryList

With this operation, it is possible to retrieve the list of available categories.

Use this REST API instead.

QueryIncidentAttachments

With this operation, it is possible retrieve a list of the incident attachments.

Use this REST API instead.

OverallStatus
 
Download WSDL
GetStatus

With this operation, it is possible to retrieve a status number for each of the services.

This API will not be replaced with a REST API equivalent.

TriggerAlarms
 
Download WSDL
QueryTriggerAlarmsSummary

With this operation, it is possible to retrieve a list of short description summaries and alarm counts.

This API is deprecated. Use the Business Automation API instead.

QueryTriggerAlarms

With this operation, it is possible to retrieve a list of more detailed information about all the active alarms. Up to 100 alarms are returned.

This API is deprecated. Use the Business Automation API instead.

ClearAlarmStatus

With this operation, it is possible to set the status of one or more alarms to cleared.

This API is deprecated. Use the Business Automation API instead.

TriggerPackageManagement
 
Download WSDL
CreateTriggerPackage

With this operation, it is possible to create a new trigger package.

This API is deprecated. Use the Business Automation API instead.

ChangeTriggerPackage

With this operation, it is possible to change a trigger package.

This API is deprecated. Use the Business Automation API instead.

DeleteTriggerPackage

With this operation, it is possible to delete a trigger package.

This API is deprecated. Use the Business Automation API instead.

QueryTriggerPackages

With this operation, it is possible to query trigger packages.

This API is deprecated. Use the Business Automation API instead.

QueryCustomerEmailAddress

With this operation, it is possible to query the e-mail addresses that are subscribed to trigger notifications.

This API is deprecated. Use the Business Automation API instead.

ChangeCustomerEmailAddress

With this operation, it is possible to add, change, or delete e-mail addresses that receive all trigger notifications. If successful, this request always overwrites the list of subscribed addresses.

This API is deprecated. Use the Business Automation API instead.

AddTriggerPackageToSubscriptionPackages

With this operation, it is possible to assign a trigger package to subscription packages.

This API is deprecated. Use the Business Automation API instead.

DeleteTriggerPackageFromSubscriptionPackages

With this operation, it is possible to remove a trigger package from the specified subscription packages.

This API is deprecated. Use the Business Automation API instead.

QueryTriggers

With this operation, it is possible to query the available triggers.

This API is deprecated. Use the Business Automation API instead.

CreateTriggerPackage_v2

With this operation, it is possible to create a new trigger package. The V2 versions of the TriggerPackageManagement operations support selectable time unit and must be used with long-term triggers.

This API is deprecated. Use the Business Automation API instead.

ChangeTriggerPackage_v2

With this operation, it is possible to change a trigger package. The V2 versions of the TriggerPackageManagement operations support selectable time unit and must be used with long-term triggers.

This API is deprecated. Use the Business Automation API instead.

QueryTriggerPackages_v2

With this operation, it is possible to query a list of trigger packages. The V2 versions of the TriggerPackageManagement operations support selectable time unit and must be used with long-term triggers.

This API is deprecated. Use the Business Automation API instead.

QueryTriggers_v2

With this operation, it is possible to query available triggers. The V2 versions of the TriggerPackageManagement operations support selectable time unit and must be used with long-term triggers.

This API is deprecated. Use the Business Automation API instead.

QueryNetworkGroups

With this operation, it is possible to query network groups.

This API is deprecated. Use the Business Automation API instead.

BundlePackageManagement
 
Download WSDL
QueryBlockedSubscriptions

This operation returns a detailed list of subscriptions that have been blocked because of the overconsumption of the bundle SMS or GPRS threshold in a specific month.

This API will not be replaced with a REST API equivalent.

RequestUnblockSubscription

With this operation, it is possible to activate a SIM subscription status that was deactivated because of overconsumption of SMS or GPRS traffic. The request returns a registered serviceRequestId meaning that the actual change can occur at a later time.

This API will not be replaced with a REST API equivalent.

ServiceRequestManagement
 
Download WSDL
QueryServiceRequests

With this operation, it is possible to retrieve the submitted service requests.

This API will not be replaced with a REST API equivalent.

QueryServiceRequestActivities

With this operation, it is possible to retrieve the activity details of a particular service request.

This API will not be replaced with a REST API equivalent.

ServiceRequestAddActivity

To add an activity to a raised service request. Only available for Request Customer Setup, Request Customer Termination, and Request Company Details Change. Attachment Files can be added to the service request.

This API will not be replaced with a REST API equivalent.

QueryServiceRequestAttachments

With this operation, it is possible retrieve the service request attachments list.

This API will not be replaced with a REST API equivalent.

DeviceReconnect
 
Download WSDL
Reconnect

The Device Reconnect function is used to reset the subscription location data in the mobile network. This can resolve problems in the network, and allow a device to reconnect.

Use the new REST API available

AddTriggerPackageToSubscriptionPackages

With this operation, it is possible to assign a trigger package to subscription packages.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:AddTriggerPackageToSubscriptionPackagesRequest>
<triggerPackageNo>1000860</triggerPackageNo>
<subscriptionPackageNameList>
<!--1 or more repetitions:-->
<subscriptionPackageName>C90000040-TSAB-SP01</subscriptionPackageName>
</subscriptionPackageNameList>
</trig:AddTriggerPackageToSubscriptionPackagesRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:AddTriggerPackageToSubscriptionPackagesResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<SubscriptionPackageTriggerPackageLinkResult>
<subscriptionPackageName>C90000040-TSAB-SP01</subscriptionPackageName>
<resultCode>SUCCESS</resultCode>
<serviceRequestId>REQ000000005649</serviceRequestId>
<requestId>REQ00000000284</requestId>
</SubscriptionPackageTriggerPackageLinkResult>
</ns2:AddTriggerPackageToSubscriptionPackagesResponse>
</env:Body>
</env:Envelope>

AggregatedTraffic

With this operation, it is possible to retrieve traffic aggregated on Total, APN, SMSC Account, CountryCode, Operator, or Opco per current day. The traffic can be filtered to a specific customer.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/AggregatedTraffic?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:view="http://iot-api.aeris.net/AggregatedTraffic">
<soapenv:Header/>
<soapenv:Body>
<view:Query>
<customerNo>00000001</customerNo>
<aggregateOn>countrycode</aggregateOn>
</view:Query>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryResponse
xmlns:ns2="http://iot-api.aeris.net/AggregatedTraffic">
<aggregatedOn>CountryCode</aggregatedOn>
<traffic>
<numberOfLUs>55</numberOfLUs>
<aggregatedOn>SE</aggregatedOn>
<activePDPContexts>66</activePDPContexts>
<gprs>
<tx>345677</tx>
<lastTx>2013-09-25Z</lastTx>
<rx>23234</rx>
<lastRx>2013-09-25Z</lastRx>
<errorCount>1</errorCount>
<lastError>2013-09-25Z</lastError>
</gprs>
<smsMo>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsMo>
<smsMt>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsMt>
<smsAo>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsAo>
<smsAt>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsAt>
</traffic>
<traffic>
<numberOfLUs>77</numberOfLUs>
<dimension>DE</dimension>
<activePDPContexts>88</activePDPContexts>
<gprs>
<tx>3</tx>
<lastTx>2013-09-25Z</lastTx>
<rx>2</rx>
<lastRx>2013-09-25Z</lastRx>
<errorCount>1</errorCount>
<lastError>2013-09-25Z</lastError>
</gprs>
<smsMo>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsMo>
<smsMt>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsMt>
<smsAo>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsAo>
<smsAt>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsAt>
</traffic>
</ns2:QueryResponse>
</env:Body>
</env:Envelope>

AggregatedTraffic_v2

With this operation, it is possible to retrieve traffic aggregated on Total, APN, SMSCAccount, CountryCode, Operator, or Opco per current day. The traffic can be filtered to a specific customer if the user has the required permissions.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/AggregatedTraffic?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:view="http://iot-api.aeris.net/AggregatedTraffic">
<soapenv:Header/>
<soapenv:Body>
<view:Query_v2>
<customerNo>00000001</customerNo>
<aggregateOn>countrycode</aggregateOn>
</view:Query_v2>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryResponse_v2
xmlns:ns2="http://iot-api.aeris.net/AggregatedTraffic">
<aggregatedOn>CountryCode</aggregatedOn>
<traffic>
<numberOfLUs>55</numberOfLUs>
<aggregatedOn>SE</aggregatedOn>
<activePDPContexts>66</activePDPContexts>
<gprs>
<tx>345677</tx>
<lastTx>2013-09-25Z</lastTx>
<rx>23234</rx>
<lastRx>2013-09-25Z</lastRx>
<errorCount>1</errorCount>
<lastError>2013-09-25Z</lastError>
</gprs>
<smsMo>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsMo>
<smsMt>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsMt>
<smsAo>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsAo>
<smsAt>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsAt>
</traffic>
<traffic>
<numberOfLUs>77</numberOfLUs>
<dimension>DE</dimension>
<activePDPContexts>88</activePDPContexts>
<gprs>
<tx>3</tx>
<lastTx>2013-09-25Z</lastTx>
<rx>2</rx>
<lastRx>2013-09-25Z</lastRx>
<errorCount>1</errorCount>
<lastError>2013-09-25Z</lastError>
</gprs>
<smsMo>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsMo>
<smsMt>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsMt>
<smsAo>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsAo>
<smsAt>
<count>1</count>
<lastTimestamp>2013-09-08T11:30:00.000Z</lastTimestamp>
<errorCount>11</errorCount>
<lastErrorTimestamp>2013-09-08T11:30:00.000Z</lastErrorTimestamp>
</smsAt>
</traffic>
</ns2:QueryResponse_v2>
</env:Body>
</env:Envelope>

ApiStatus

With this operation, it is possible to verify that the API is operational by sending a message string to the API and verify that it is returned.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/ApiStatus?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:oper="http://iot-api.aeris.net/ApiStatus">
<soapenv:Header/>
<soapenv:Body>
<apis:Echo>
<message>hello</message>
</apis:Echo>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:echoResponse
xmlns:ns2="http://iot-api.aeris.net/ApiStatus">
<message>hello</message>
</ns2:echoResponse>
</env:Body>
</env:Envelope>

ChangeAlternativeRoamingProvider

With this operation, it is possible to change Alternative Roaming Provider (ARP) details for a single subscription. The request returns a registered serviceRequestId, indicating that the actual change can occur at a later time.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:

Assigning an ARP to a subscription:

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:ChangeAlternativeRoamingProvider>
<resource>
<id>240084604569763</id>
<type>imsi</type>
</resource>
<tadig>OPA01</tadig>
</sub:ChangeAlternativeRoamingProvider>
</soapenv:Body>
</soapenv:Envelope>

Or removing an ARP assigned to the subscription:

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:ChangeAlternativeRoamingProvider>
<resource>
<id>240084604569763</id>
<type>imsi</type>
</resource>
<tadig></tadig>
</sub:ChangeAlternativeRoamingProvider>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:

Assigning an ARP to a subscription:

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:ChangeAlternativeRoamingProviderResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<serviceRequestId>REQ000000047001</serviceRequestId>
</ns2:ChangeSubscriptionRegionResponse>
</env:Body>
</env:Envelope>

Or removing an ARP assigned to the subscription:

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:ChangeAlternativeRoamingProviderResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<serviceRequestId>REQ000000047002</serviceRequestId>
</ns2:ChangeSubscriptionRegionResponse>
</env:Body>
</env:Envelope>

ChangeCustomerEmailAddress

With this operation, it is possible to add, change, or delete e-mail addresses that receive all trigger notifications. If successful, this request always overwrites the list of subscribed addresses.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:ChangeCustomerEmailAddressRequest>
<customerNo>00000001</customerNo>
<emailAddress>[email protected],[email protected],[email protected]</emailAddress>
</trig:ChangeCustomerEmailAddressRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns1:ChangeCustomerEmailAddressResponse xsi:nil="1" ⇒
xmlns:ns1="http://iot-api.aeris.net/TriggerPackageManagement" ⇒
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</env:Body>
</env:Envelope>

ChangeSubscriptionRegion

With this operation, it is possible to change the region for a single subscription.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:ChangeSubscriptionRegion>
<customerNo>99000010</customerNo>
<resource>
<id>240081020000014</id>
<type>imsi</type>
</resource>
<newRegion>denmark</newRegion>
</sub:ChangeSubscriptionRegion>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:ChangeSubscriptionRegionResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<serviceRequestId>REQ000000098</serviceRequestId>
<requestId>REQ000000097</requestId>
</ns2:ChangeSubscriptionRegionResponse>
</env:Body>
</env:Envelope>

ChangeTriggerPackage

With this operation, it is possible to change a trigger package.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:TriggerPackageChangeRequest>
<triggerPackage>
<customerNo>00000001</customerNo>
<packageNo>54</packageNo>
<name>Data limit trigger</name>
<description>data quote alert</description>
<lastChange></lastChange>
<triggerMetrics>
<triggerMetric>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run per timeframe</triggerName>
<timeFrame>48</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
<lastChange></lastChange>
</triggerMetric>
</triggerMetrics>
</triggerPackage>
</trig:TriggerPackageChangeRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:TriggerPackageChangeResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<triggerPackage>
<customerNo>00000001</customerNo>
<packageNo>54</packageNo>
<name>Activity trigger</name>
<description>Package Description</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>1</triggerNumber>
<triggerName>No location update</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>2</triggerNumber>
<triggerName>Roaming not allowed</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>5</triggerNumber>
<triggerName>PDP Context Activation attempts per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run per timeframe</triggerName>
<timeFrame>48</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>10</triggerNumber>
<triggerName>SMS MO over run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>11</triggerNumber>
<triggerName>SMS MO under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>12</triggerNumber>
<triggerName>SMS MT over run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>13</triggerNumber>
<triggerName>SMS MT under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>14</triggerNumber>
<triggerName>Net activity under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
</triggerMetrics>
</triggerPackage>
</ns2:TriggerPackageChangeResponse>
</env:Body>
</env:Envelope>

ChangeTriggerPackage_v2

With this operation, it is possible to change a trigger package. The V2 versions of the TriggerPackageManagement operations support selectable time unit and must be used with long-term triggers.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:TriggerPackageChangeRequest_v2>
<triggerPackage>
<customerNo>00000001</customerNo>
<packageNo>11</packageNo>
<name>Data pack</name>
<description>Data limit alert</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<timeFrame>1</timeFrame>
<timeFrameUnit>hour</timeFrameUnit>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
</triggerMetrics>
</triggerPackage>
</trig:TriggerPackageChangeRequest_v2>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:TriggerPackageChangeResponse_v2 ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<triggerPackage>
<customerNo>00000001</customerNo>
<packageNo>11</packageNo>
<name>Activity Package</name>
<description>Pack description</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>1</triggerNumber>
<triggerName>No location update</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>2</triggerNumber>
<triggerName>Roaming not allowed</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>5</triggerNumber>
<triggerName>PDP Context Activation attempts per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>7</triggerNumber>
<triggerName>GPRS Long term over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>9</triggerNumber>
<triggerName>SMS MO Long term over run per timeframe</triggerName>
<timeFrame>3</timeFrame>
<timeFrameUnit>week</timeFrameUnit>
<alertActive>true</alertActive>
<alertValue>100</alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
<lastChange>2017-07-24Z</lastChange>
</triggerMetric>
<triggerMetric>
<triggerNumber>10</triggerNumber>
<triggerName>SMS MO over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>11</triggerNumber>
<triggerName>SMS MO under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>12</triggerNumber>
<triggerName>SMS MT over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>13</triggerNumber>
<triggerName>SMS MT under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>14</triggerNumber>
<triggerName>Net activity under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>15</triggerNumber>
<triggerName>GPRS Long term Network Group 1</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>16</triggerNumber>
<triggerName>GPRS Long term Network Group 2</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>17</triggerNumber>
<triggerName>GPRS Long term other networks</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>18</triggerNumber>
<triggerName>SMS MO Long term Network Group 1</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>19</triggerNumber>
<triggerName>SMS MO Long term Network Group 2</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>20</triggerNumber>
<triggerName>SMS MO Long term other networks</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
</triggerMetrics>
</triggerPackage>
</ns2:TriggerPackageChangeResponse_v2>
</env:Body>
</env:Envelope>

ClearAlarmStatus

With this operation, it is possible to set the status of one or more alarms to be cleared.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerAlarms?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerAlarms">
<soapenv:Header/>
<soapenv:Body>
<trig:ClearAlarmStatus>
<customerNo>00000001</customerNo>
<alarmId>1234</alarmId>
<alarmId>1235</alarmId>
</trig:ClearAlarmStatus>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:ClearAlarmStatusResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerAlarms">Success
</ns2:ClearAlarmStatusResponse>
</env:Body>
</env:Envelope>

CreateTriggerPackage

With this operation, it is possible to create a new trigger package.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:TriggerPackageCreateRequest>
<customerNo>00000000</customerNo>
<name>Trigger Package A</name>
<description>Data underrun</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run per timeframe</triggerName>
<timeFrame>48</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
<lastChange></lastChange>
</triggerMetric>
</triggerMetrics>
</trig:TriggerPackageCreateRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:TriggerPackageCreateResponse
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<triggerPackage>
<customerNo>00000001</customerNo>
<packageNo>54</packageNo>
<name>Test Pack</name>
<description>Test Pack Description</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>1</triggerNumber>
<triggerName>No location update</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>2</triggerNumber>
<triggerName>Roaming not allowed</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>5</triggerNumber>
<triggerName>PDP Context Activation attempts per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run per timeframe</triggerName>
<timeFrame>48</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>10</triggerNumber>
<triggerName>SMS MO over run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>11</triggerNumber>
<triggerName>SMS MO under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>12</triggerNumber>
<triggerName>SMS MT over run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>13</triggerNumber>
<triggerName>SMS MT under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>14</triggerNumber>
<triggerName>Net activity under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
</triggerMetrics>
</triggerPackage>
</ns2:TriggerPackageCreateResponse>
</env:Body>
</env:Envelope>

CreateTriggerPackage_v2

With this operation, it is possible to create a new trigger package. The V2 versions of the TriggerPackageManagement operations support selectable time unit and must be used with long-term triggers.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:TriggerPackageCreateRequest_v2>
<customerNo>00000001</customerNo>
<name>Test Pack</name>
<description>Test Pack Description</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>9</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<timeFrame>1</timeFrame>
<timeFrameUnit>month</timeFrameUnit>
<alertActive>false</alertActive>
<alertValue>123</alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
</triggerMetrics>
</trig:TriggerPackageCreateRequest_v2>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:TriggerPackageCreateResponse_v2 ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<triggerPackage>
<customerNo>00000001</customerNo>
<packageNo>11</packageNo>
<name>Activity Package</name>
<description>Pack description</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>1</triggerNumber>
<triggerName>No location update</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>2</triggerNumber>
<triggerName>Roaming not allowed</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>5</triggerNumber>
<triggerName>PDP Context Activation attempts per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short Term Over run</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>7</triggerNumber>
<triggerName>GPRS Long term over run</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>9</triggerNumber>
<triggerName>SMS MO Long term over run per timeframe</triggerName>
<timeFrame>1</timeFrame>
<timeFrameUnit>month</timeFrameUnit>
<alertActive>true</alertActive>
<alertValue>1</alertValue>
<actionActive>true</actionActive>
<actionValue>100</actionValue>
<lastChange>2017-07-24Z</lastChange>
</triggerMetric>
<triggerMetric>
<triggerNumber>10</triggerNumber>
<triggerName>SMS MO over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>11</triggerNumber>
<triggerName>SMS MO under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>12</triggerNumber>
<triggerName>SMS MT over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>13</triggerNumber>
<triggerName>SMS MT under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>14</triggerNumber>
<triggerName>Net activity under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>15</triggerNumber>
<triggerName>GPRS Long term Network Group 1</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>16</triggerNumber>
<triggerName>GPRS Long term Network Group 2</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>17</triggerNumber>
<triggerName>GPRS Long term other networks</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>18</triggerNumber>
<triggerName>SMS MO Long term Network Group 1</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>19</triggerNumber>
<triggerName>SMS MO Long term Network Group 2</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>20</triggerNumber>
<triggerName>SMS MO Long term other networks</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
</triggerMetrics>
</triggerPackage>
</ns2:TriggerPackageCreateResponse_v2>
</env:Body>
</env:Envelope>

DeleteInvoices

With this operation, it is possible to delete an invoice file using its invoiceName.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/ReportDownload?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:rep="http://iot-api.aeris.net/reportdownload">
<soapenv:Header/>
<soapenv:Body>
<rep:DeleteInvoices>
<invoiceName>2012-02-23-11-56-00C99000010TINVOICE.pdf</invoiceName>
</rep:DeleteInvoices>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:DeleteInvoicesResponse
xmlns:ns2="http://iot-api.aeris.net/reportdownload">
<invoicesStatus>Success</invoicesStatus>
</ns2:DeleteInvoicesResponse>
</env:Body>
</env:Envelope>

DeleteTriggerPackage

With this operation, it is possible to delete a trigger package.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:TriggerPackageDeleteRequest>
<customerNo>00000001</customerNo>
<packageNo>11</packageNo>
</trig:TriggerPackageDeleteRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns1:TriggerPackageDeleteResponse
xmlns:ns1="http://iot-api.aeris.net/TriggerPackageManagement"
</ns1:TriggerPackageDeleteResponse>
</env:Body>
</env:Envelope>

DeleteTriggerPackageFromSubscriptionPackages

With this operation, it is possible to remove a trigger package from the specified subscription packages.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:DeleteTriggerPackageFromSubscriptionPackagesRequest>
<subscriptionPackageNameList>
<!--1 or more repetitions:-->
<subscriptionPackageName>C90000040-TSAB-SP01</subscriptionPackageName>
</subscriptionPackageNameList>
</trig:DeleteTriggerPackageFromSubscriptionPackagesRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<env:Header/>
<env:Body>
<ns2:DeleteTriggerPackageFromSubscriptionPackageResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<SubscriptionPackageTriggerPackageLinkResult>
<subscriptionPackageName>C90000040-TSAB-SP01</subscriptionPackageName>
<resultCode>SUCCESS</resultCode>
<serviceRequestId>REQ000000005660</serviceRequestId>
</SubscriptionPackageTriggerPackageLinkResult>
</ns2:DeleteTriggerPackageFromSubscriptionPackageResponse>
</env:Body>
</env:Envelope>

GetStatus

With this operation, it is possible to retrieve a status number for each of the services.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/OverallStatus?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:over="http://iot-api.aeris.net/OverallStatus">
<soapenv:Header/>
<soapenv:Body>
<over:GetStatus></over:GetStatus>
</soapenv:Body>
</soapenv:Envelope>

Or (Optionally running on behalf of a customer)

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:over="http://iot-api.aeris.net/OverallStatus">
<soapenv:Header/>
<soapenv:Body>
<over:GetStatus>
<customerNo>00000001</customerNo>
</over:GetStatus>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:GetStatusResponse
xmlns:ns2="http://iot-api.aeris.net/OverallStatus">
<voice>1</voice>
<cSD>1</cSD>
<sMS>2</sMS>
<gPRS>1</gPRS>
<customerAccessService>2</customerAccessService>
<customerSMSCAccount>3</customerSMSCAccount>
</ns2:GetStatusResponse>
</env:Body>
</env:Envelope>

IncidentManagement - Details

With this operation, it is possible to retrieve additional details for a single incident service request.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/IncidentManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
      xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
         <soapenv:Header/>
         <soapenv:Body>
            <inc:DetailsQuery>
               <incidentID>INC000000000251</incidentID>
            </inc:DetailsQuery>
         </soapenv:Body>
      </soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
      xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
         <soapenv:Header/>
         <soapenv:Body>
            <inc:DetailsResponse>
               <notes>This submitted incident is just a test.</notes>
               <resolution>This is a test Resolution entry for R1.1</resolution>
               <activityLog>
                  <id>WLG000000000163</id>
                  <description>Testing PUBLIC Workinfo Details API for R1.1</description>
                  <detailedDescription>Testing Workinfo Details API for R1.1</detailedDescription>
                  <submitDate>2010-01-15T11:27:41.000Z</submitDate>
                  <submitter>Test</submitter>
               </activityLog>
               <activityLog>
                  <id>WLG000000000162</id>
                  <description>This is a test workinfo entry for R1.1</description>
                  <detailedDescription>This is a test workinfo entry for R1.1</detailedDescription>
                  <submitDate>2010-01-15T11:26:52.000Z</submitDate>
                  <submitter>Test</submitter>
               </activityLog>
               <activityLog>
                  <id>WLG000000000152</id>
                  <description>This ticket was created from the service request system</description>
                  <detailedDescription></detailedDescription>
                  <submitDate>2010-01-15T10:15:44.000Z</submitDate>
                  <submitter>Remedy Application Service</submitter>
               </activityLog>
            </inc:DetailsResponse>
         </soapenv:Body>
      </soapenv:Envelope>

IncidentManagement - Log Incident

With this operation, it is possible to raise an incident request.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/IncidentManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
      xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
         <soapenv:Header/>
         <soapenv:Body>
            <inc:LogIncidentRequest>
                <customerNo>99000010</customerNo>
               <summary>SIM management problem</summary>
               <urgency>medium</urgency>
               <impact>moderate/limited</impact>
               <categoryLevel1>Access</categoryLevel1>
               <notes>test data</notes>
               <site>chennai</site>
               <attachments>
                  <!--1 to 3 repetitions:-->
                  <attachment>
                     <fileName>capture</fileName>
                     <attachmentData>cid:31732773280</attachmentData>
                  </attachment>
                  <attachment>
                     <fileName>capture1</fileName>
                     <attachmentData>cid:31732773281</attachmentData>
                  </attachment>
                  <attachment>
                     <fileName>capture2</fileName>
                     <attachmentData>cid:31732773282</attachmentData>
                  </attachment>
               </attachments>
            </inc:LogIncidentRequest>
         </soapenv:Body>
      </soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
         <env:Header/>
         <env:Body>
            <ns2:LogIncidentResponse xmlns:ns2="http://iot-api.aeris.net/IncidentManagement">
               <incidentId>INC100000000266</incidentId>
               <serviceRequestID>REQ</serviceRequestID>
            </ns2:LogIncidentResponse>
         </env:Body>
      </env:Envelope>

IncidentManagement - LogIncidentActivity

With this operation, it is possible add an activity to a raised incident.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/IncidentManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
      xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
         <soapenv:Header/>
         <soapenv:Body>
               <inc:LogIncidentActivity>
               <customerNo>99000010</customerNo>
               <incidentId>INC000000012599</incidentId>
               <summary>test</summary>
               <notes>test data</notes>
               <attachments>
                  <!--1 to 3 repetitions:-->
                  <attachment>
                     <fileName>activity</fileName>
                     <attachmentData>cid:465408944033</attachmentData>
                  </attachment>
                  <attachment>
                     <fileName>activity1</fileName>
                     <attachmentData>cid:465408944034</attachmentData>
                    </attachment>
                  <attachment>
                     <fileName>activity2</fileName>
                     <attachmentData>cid:465408944035</attachmentData>
                  </attachment>
               </attachments>
            </inc:LogIncidentActivity>
         </soapenv:Body>
      </soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
         <env:Header/>
         <env:Body>
            <ns2:LogIncidentActivityResponse xmlns:ns2="http://iot-api.aeris.net/IncidentManagement">
               <incidentId>INC000000012599</incidentId>
            </ns2:LogIncidentActivityResponse>
         </env:Body>
      </env:Envelope>

IncidentManagement - Query Company Site Details

With this operation, it is possible to retrieve available company site details.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/IncidentManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
      xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
         <soapenv:Header/>
         <soapenv:Body>
            <inc:QueryCompanySiteDetails>
               <customerNo>99000010</customerNo>
            </inc:QueryCompanySiteDetails>
         </soapenv:Body>
      </soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
         <env:Header/>
         <env:Body>
            <ns2:QueryCompanySiteDetailsResponse xmlns:ns2="http://iot-api.aeris.net/IncidentManagement">
               <site>
                  <siteName>Enterprise A Site 1</siteName>
               </site>
               <site>
                  <siteName>Enterprise A Site 2</siteName>
               </site>
               <site>
                  <siteName>Enterprise A Site 3</siteName>
               </site>
               <site>
                  <siteName>Enterprise A Site 4</siteName>
               </site>
               <site>
                  <siteName>Enterprise A Site 5</siteName>
               </site>
            </ns2:QueryCompanySiteDetailsResponse>
         </env:Body>
      </env:Envelope>

IncidentManagement - Query Incident Attachments

With this operation, it is possible retrieve a list of the incident attachments.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/IncidentManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
      xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
         <soapenv:Header/>
         <soapenv:Body>
            <inc:QueryIncidentAttachments>
               <customerNo>99000010</customerNo>
               <activityLogId>WLI000000012599</activityLogId>
               <timedOut>2</timedOut>
            </inc:QueryIncidentAttachments>
         </soapenv:Body>
      </soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
         <env:Header/>
         <env:Body>
            <ns2:QueryIncidentAttachmentsResponse ⇒
            xmlns:ns2="http://iot-api.aeris.net/IncidentManagement">
               <attachments>
                  <attachment>
                     <fileName>capture2</fileName>
                     <attachmentData>
                        <xop:Include href="cid:[email protected]" ⇒
                        xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
                     </attachmentData>
                  </attachment>
               </attachments>
            </ns2:QueryIncidentAttachmentsResponse>
         </env:Body>
      </env:Envelope>

IncidentManagement - Query Incident Category List

With this operation, it is possible to retrieve the list of available categories.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/IncidentManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
      xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
         <soapenv:Header/>
         <soapenv:Body>
            <inc:QueryIncidentCategoryList>
               <customerNo>99000010</customerNo>
            </inc:QueryIncidentCategoryList>
         </soapenv:Body>
      </soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">;
         <env:Header/>
         <env:Body>
            <ns2:QueryIncidentCategoryListResponse xmlns:ns2="http://iot-api.aeris.net/IncidentManagement">;
               <categoryLevel1>
                  <name>Access</name>
               </categoryLevel1>
               <categoryLevel1>
                  <name>API</name>
               </categoryLevel1>
               <categoryLevel1>
                  <name>Company Set-up</name>
               </categoryLevel1>
               <categoryLevel1>
                  <name>Connectivity</name>
               </categoryLevel1>
               <categoryLevel1>
                  <name>Customer Termination</name>
               </categoryLevel1>
               <categoryLevel1>
                  <name>Other</name>
               </categoryLevel1>
               <categoryLevel1>
                  <name>Service Portal</name>
               </categoryLevel1>
               <categoryLevel1>
                  <name>Platform Supplier</name>
               </categoryLevel1>
            </ns2:QueryIncidentCategoryListResponse>
         </env:Body>
      </env:Envelope>

QueryTrafficUsageHistory

With this operation, it is possible to retrieve previously aggregated traffic usage information from a specific time period. The traffic can be filtered on a specific sub-customer if the user has the authority.

IMPORTANT! This SOAP API will be deprecated.
Example of API request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:agg="http://iot-api.aeris.net/AggregatedTraffic">
 <soapenv:Header/>
  <soapenv:Body>
   <agg:QueryTrafficUsageHistory>
    <customerNo>00000001</customerNo>
    <startDate>2016-11-01</startDate>
    <endDate>2016-11-08</endDate>
   </agg:QueryTrafficUsageHistory>
  </soapenv:Body>
</soapenv:Envelope>
Example of API response:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
 <env:Body>
  <ns2:QueryTrafficUsageHistoryResponse ⇒
  xmlns:ns2="http://iot-api.aeris.net/AggregatedTraffic">
   <trafficUsage>
    <aggregationDate>2013-11-01Z</aggregationDate>
    <gprsVolume>0</gprsVolume>
    <smsVolume>2</smsVolume>
   </trafficUsage>
  </ns2:QueryTrafficUsageHistoryResponse>
 </env:Body>
</env:Envelope>

QueryAllContractSubscriptionPackages

With this operation, it is possible to retrieve a list of all subscription packages together with trigger package information. It also lists those subscription packages to which subscriptions cannot be assigned.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QueryAllContractSubscriptionPackages>
<customerNo>00000001</customerNo>
</sub:QueryAllContractSubscriptionPackages>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryAllContractSubscriptionPackagesResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<subscriptionPackage>
<description>Enterprise A SP11 Basic</description>
<id>88000001001_SP_11</id>
<serviceContractId>T09121002_SC_01</serviceContractId>
<company>Enterprise A</company>
</subscriptionPackages>
<subscriptionPackage>
<description>Enterprise A SP12 Advanced</description>
<id>88000001001_SP_12</id>
<serviceContractId>T09121002_SC_01</serviceContractId>
<triggerPackageNo>1000348</triggerPackageNo>
<company>Enterprise A</company>
</subscriptionPackages>
</ns2:QueryAllContractSubscriptionPackagesResponse>
</env:Body>
</env:Envelope>

QueryAvailableRegions

With this operation, it is possible to retrieve the available regions for a single subscription.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QueryAvailableRegions>
<resource>
<id>240081020000014</id>
<type>imsi</type>
</resource>
</sub:QueryAvailableRegions>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryAvailableRegionsResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagemnet">
<regionShortNameList>
<regionShortName>denmark</regionShortName>
<regionShortName>sweden</regionShortName>
</regionShortNameList>
</ns2:QueryAvailableRegionsResponse>
</env:Body>
</env:Envelope>

QueryAverageTrafficUsageHistory

With this operation, it is possible to retrieve previously aggregated traffic usage information from a specific time period together with the number of active subscriptions on each required date. The traffic can be filtered on a specific sub-customer if the user has the authority.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/AggregatedTraffic?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:agg="http://iot-api.aeris.net/AggregatedTraffic">
<soapenv:Header/>
<soapenv:Body>
<agg:QueryAverageTrafficUsageHistory>
<customerNo>00000001</customerNo>
<startDate>2016-11-01</startDate>
<endDate>2016-11-08</endDate>
</agg:QueryAverageTrafficUsageHistory>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryAverageTrafficUsageHistoryResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/AggregatedTraffic">
<averageTrafficUsage>
<aggregationDate>2013-11-01</aggregationDate>
<gprsVolume>0</gprsVolume>
<smsVolume>2</smsVolume>
<activeSubscriptionsCount>4</activeSubscriptionsCount>
</averageTrafficUsage>
</ns2:QueryAverageTrafficUsageHistoryResponse>
</env:Body>
</env:Envelope>

QueryBlockedSubscriptions

This operation returns a detailed list of subscriptions that have been blocked because of the overconsumption of the bundle SMS or GPRS threshold in a specific month.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/BundlePackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/BundlePackageManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QueryBlockedSubscriptions>
<customerNo>00000001</customerNo>
</sub:QueryBlockedSubscriptions>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryBlockedSubscriptionsResponse
xmlns:ns2="http://iot-api.aeris.net/BundlePackageManagement">
<blockedSubscriptionDetails>
<blockedSubscriptionDetail>
<imsi>320123456000016</imsi>
<msisdn>45201304821065</msisdn>
<icc>600150</icc>
<customerLabel>Spare IMSI</customerLabel>
<bundleName>B M No2</bundleName>
<status>Active</status>
<trafficType>gprs</trafficType>
<thresholdLimit>10000000</thresholdLimit>
<thresholdUnit>bytes</thresholdUnit>
<networkGroup>1</networkGroup>
<blockedDate>2013-11-22T09:29:53.000Z</blockedDate>
<unBlockedDate>2013-11-26T09:15:47.000Z</unBlockedDate>
</blockedSubscriptionDetail>
<blockedSubscriptionDetail>
<imsi>320123456001548</imsi>
<msisdn>52014100987654</msisdn>
<icc>900011</icc>
<customerLabel>bundle2</customerLabel>
<bundleName>B M No2</bundleName>
<status>Active</status>
<trafficType>sms</trafficType>
<thresholdLimit>30</thresholdLimit>
<thresholdUnit>pcs</thresholdUnit>
<networkGroup>1</networkGroup>
<blockedDate>2013-11-22T10:25:54.000Z</blockedDate>
<unBlockedDate>2013-11-26T09:19:25.000Z</unBlockedDate>
</blockedSubscriptionDetail>
<blockedSubscriptionDetail>
<imsi>320123456001754</imsi>
<msisdn>201330876976871</msisdn>
<icc>600150</icc>
<bundleName>B M No6</bundleName>
<status>Deactivated</status>
<trafficType>sms</trafficType>
<thresholdLimit>10</thresholdLimit>
<thresholdUnit>pcs</thresholdUnit>
<networkGroup>1</networkGroup>
<blockedDate>2013-11-26T09:15:47.000Z</blockedDate>
</blockedSubscriptionDetail>
<blockedSubscriptionDetail>
<imsi>320123456000017</imsi>
<msisdn>52012006345678</msisdn>
<icc>600150</icc>
<customerLabel>bundle2</customerLabel>
<bundleName>B M No2</bundleName>
<status>Active</status>
<trafficType>sms</trafficType>
<thresholdLimit>30</thresholdLimit>
<thresholdUnit>pcs</thresholdUnit>
<networkGroup>2</networkGroup>
<blockedDate>2013-11-20T13:06:54.000Z</blockedDate>
<unBlockedDate>2013-11-26T09:15:46.000Z</unBlockedDate>
</blockedSubscriptionDetail>
<blockedSubscriptionDetail>
<imsi>320123456001550</imsi>
<msisdn>52014100000234</msisdn>
<icc>900013</icc>
<bundleName>B M No99</bundleName>
<status>Active</status>
<trafficType>gprs</trafficType>
<thresholdLimit>10000000</thresholdLimit>
<thresholdUnit>bytes</thresholdUnit>
<networkGroup>Total</networkGroup>
<blockedDate>2013-11-22T10:29:32.000Z</blockedDate>
<unBlockedDate>2013-11-26T09:15:47.000Z</unBlockedDate>
</blockedSubscriptionDetail>
<blockedSubscriptionDetail>
<imsi>320123456001552</imsi>
<msisdn>52014104340023</msisdn>
<icc>900015</icc>
<bundleName>B M No2</bundleName>
<status>Active</status>
<trafficType>sms</trafficType>
<thresholdLimit>30</thresholdLimit>
<thresholdUnit>pcs</thresholdUnit>
<networkGroup>Others</networkGroup>
<blockedDate>2013-11-22T07:08:02.000Z</blockedDate>
<unBlockedDate>2013-11-26T09:15:47.000Z</unBlockedDate>
</blockedSubscriptionDetail>
</blockedSubscriptionDetails>
</ns2:QueryBlockedSubscriptionsResponse>
</env:Body>
</env:Envelope>

QueryCustomerEmailAddress

With this operation, it is possible to query the e-mail addresses that are subscribed to trigger notifications.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:QueryCustomerEmailAddressRequest>
<customerNo>00000001</customerNo>
</trig:QueryCustomerEmailAddressRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryCustomerEmailAddressResponse
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<emailAddress>[email protected],[email protected],[email protected]</emailAddress>
</ns2:QueryCustomerEmailAddressResponse>
</env:Body>
</env:Envelope>

QueryInvoices

With this operation, it is possible to retrieve a list of invoice data files that can be downloaded.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/ReportDownload?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:rep="http://iot-api.aeris.net/reportdownload">
<soapenv:Header/>
<soapenv:Body>
<rep:QueryInvoices>
<invoiceType>INVOICE</invoiceType>
<fromDate>2016-02-01</fromDate>
<toDate>2016-02-24</toDate>
</rep:QueryInvoices>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryInvoicesResponse
xmlns:ns2="http://iot-api.aeris.net/reportdownload">
<InvoiceData>
<url>/iapi/invoicedata?id=1328097360000:INVOICE</url>
<invoiceName>2012-02-01-11-56-00C99000010TINVOICE.pdf</invoiceName>
<invoiceDate>2012-02-01T11:56:00.000Z</invoiceDate>
<size>184241</size>
<invoiceType>INVOICE</invoiceType>
</InvoiceData>
<InvoiceData>
<url>/iapi/invoicedata?id=1328054400000:INVOICE</url>
<invoiceName>2012-02-01-00-00-00C99000010TINVOICE.pdf</invoiceName>
<invoiceDate>2012-02-01T00:00:00.000Z</invoiceDate>
<size>184241</size>
<invoiceType>INV_DET</invoiceType>
</InvoiceData>
<InvoiceData>
<url>/iapi/invoicedata?id=1329955200000:INVOICE</url>
<invoiceName>2012-02-23-00-00-00C99000010TINVOICE.pdf</invoiceName>
<invoiceDate>2012-02-23T00:00:00.000Z</invoiceDate>
<size>184241</size>
<invoiceType>INVOICE</invoiceType>
</InvoiceData>
</ns2:QueryInvoicesResponse>
</env:Body>
</env:Envelope>

QueryNetworkGroups

With this operation, it is possible to query network groups.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:QueryNetworkGroupsRequest>
<customerNo>10000001</customerNo>
</trig:QueryTriggerPackagesRequest_v2>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryNetworkGroupsResponse
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<networkGroups>
<networkGroup>
<networkGroupNo>1</networkGroupNo>
<networkGroupMembers>
<networkGroupMember>
<countryName>India</countryName>
<operatorName>Operator A</operatorName>
</networkGroupMember>
<networkGroupMember>
<countryName>India</countryName>
<operatorName>Operator B</operatorName>
</networkGroupMember>
</networkGroupMembers>
</networkGroup>
<networkGroup>
<networkGroupNo>2</networkGroupNo>
<networkGroupMembers>
<networkGroupMember>
<countryName>Sweden</countryName>
<operatorName>Operator C</operatorName>
</networkGroupMember>
<networkGroupMember>
<countryName>Sweden</countryName>
<operatorName>Operator D</operatorName>
</networkGroupMember>
<networkGroupMember>
<countryName>Finland</countryName>
<operatorName>Operator D</operatorName>
</networkGroupMember>
</networkGroupMembers>
</networkGroup>
</networkGroups>
</ns2:QueryNetworkGroupsResponse>
</env:Body>
</env:Envelope>undefinedundefined</env:Envelope>

QueryServiceRequestActivities

With this operation, it is possible to retrieve the activity details of a particular service request.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/ServiceRequestManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:ser="http://iot-api.aeris.net/ServiceRequestManagement">
<soapenv:Header/>
<soapenv:Body>
<ser:QueryServiceRequestActivities>
<serviceRequestId>REQ000000029587</serviceRequestId>
</ser:QueryServiceRequestActivities>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryServiceRequestActivitiesResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/ServiceRequestManagement">
<activityLog>
<activityLogId>000000000021907</activityLogId>
<activitySummary>Refer to Attachments for a Report of
IMSI-MSISDN pairs ordered as part of this Order</activitySummary>
<submitDate>2013-12-31T13:37:01Z</submitDate>
<submittedBy>ImpactManager</submittedBy>
<attachmentNames>
<attachmentName>REQ000000029587_INT00014044512.csv</attachmentName>
</attachmentNames>
</activityLog>
</ns2:QueryServiceRequestActivitiesResponse>
</env:Body>
</env:Envelope>

QueryServiceRequestAttachments

With this operation, it is possible retrieve the service request attachments list.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/ServiceRequestManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:ser="http://iot-api.aeris.net/ServiceRequestManagement">
<soapenv:Header/>
<soapenv:Body>
<ser:QueryServiceRequestAttachments>
<activityLogId>000000000021907</activityLogId>
<timedOut>2</timedOut>
</ser:QueryServiceRequestAttachments>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryServiceRequestAttachmentsResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/ServiceRequestManagement">
<attachments>
<attachment>
<fileName>REQ000000029587.csv</fileName>
<attachmentData>
<xop:Include href="cid:attachmentData-7b9ca9ab-7b0d-491e-bea5- ⇒
[email protected]"
xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</attachmentData>
</attachment>
</attachments>
</ns2:QueryServiceRequestAttachmentsResponse>
</env:Body>
</env:Envelope>

QueryServiceRequests

With this operation, it is possible to retrieve the submitted service requests.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/ServiceRequestManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:ser="http://iot-api.aeris.net/ServiceRequestManagement">
<soapenv:Header/>
<soapenv:Body>
<ser:QueryServiceRequests>
<customerNo>00000001</customerNo>
<startDate>2013-12-16</startDate>
<endDate>2014-01-15</endDate>
<serviceRequestId>REQ000000003</serviceRequestId>
</ser:QueryServiceRequests>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryServiceRequestsResponse
xmlns:ns2="http://iot-api.aeris.net/ServiceRequestManagement">
<ServiceRequestResponseData>
<serviceRequestId>REQ000000033171</serviceRequestId>
<serviceRequestSummary>Request Company Details Change</serviceRequestSummary>
<serviceRequestNotes>update company details as Enterprise A</serviceRequestNotes>
<serviceRequestStatus>In Progress</serviceRequestStatus>
<submitDate>2014-02-11T11:59:30Z</submitDate>
<company>Enteprise A</company>
<customerNo>30022001</customerNo>
<initiatedBy>
<firstName>John</firstName>
<lastName>Doe</lastName>
</initiatedBy>
<serviceRequestType>Request Company Details Change</serviceRequestType>
<requiredDate>2014-08-10T22:00:00Z</requiredDate>
<urgency>critical</urgency>
<categoryLevel1>Company Set-up</categoryLevel1>
<phoneNumber>9876543210</phoneNumber>
<emailAddress>[email protected]</emailAddress>
</ServiceRequestResponseData>
</ns2:QueryServiceRequestsResponse>
</env:Body>
</env:Envelope>

QuerySimResource

With this operation, it is possible to retrieve SIM resource information by giving a valid number of IMSI, IMEI, MSISDN, or ICC.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

Look at the API migration tutorial Here

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sim="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sim:QuerySimResource>
<resource>
<id>1234567891234</id>
<type>msisdn</type>
</resource>
</sim:QuerySimResource>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySimResourceResponse xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<SimResource>
<customerLabel>Operator A SIM 000</customerLabel>
<msisdn>1234567891234</msisdn>
<imsi>123456789123456</imsi>
<icc>12345678912345678912</icc>
<pin1>0000</pin1>
<pin2>1111</pin2>
<puk1>00000000</puk1>
<puk2>11111111</puk2>
<imei>123456789123456</imei>
<assignedImei>123456789123456</assignedImei>
<customerNo>00000001</customerNo>
<site></site>
<accessControlClass></accessControlClass>
<roamProfileName>Operator A RP 2</roamProfileName>
<roamProfileDesc></roamProfileDesc>
<deviceTerminalType>123456789123</deviceTerminalType>
<simSubscriptionStatus>Ordered</simSubscriptionStatus>
<simResourceStatus>Ordered</simResourceStatus>
<simCardDescription>Operator A SIM Card2_9</simCardDescription>
<simSpecification>0001</simSpecification>
<priceProfileName>Operator A Price Profile 2</priceProfileName>
<priceProfileDesc>Operator A Price Profile 2</priceProfileDesc>
<productOfferName>Operator A PO 2</productOfferName>
<pdpContextProfileName></pdpContextProfileName>
<deliveryDate>2013-12-18T16:54:23.000+01:00</deliveryDate>
<firstActivationDate>2013-12-18T16:54:23.000+01:00</firstActivationDate>
<tenantId>2</tenantId>
<userProfileId>Roaming Profile 02</userProfileId>
<gprs>true</gprs>
<lte>true</lte>
<smsMo>false</smsMo>
<smsMt>false</smsMt>
<csd>false</csd>
<voice>false</voice>
<clip>true</clip>
<consumerConnectivity>true</consumerConnectivity>
<apns>
<apn>
<name>internet.opa.xx</name>
<description>Operator A Internet APN</description>
</apn>
</apns>
<installationDate>2012-05-05T07:04:55Z</installationDate>
<triggerPackage>Triggers for TEST-OPA-CHILD 1000266</triggerPackage>
<pbrExitDate>2012-11-24</pbrExitDate>
<lastSubscriptionDateChange>2012-11-26</lastSubscriptionDateChange>
<moveToPermitted>YES</moveToPermitted>
<freezeDuration>3</freezeDuration>
<chargeCodeForPPMove>true</chargeCodeForPPMove>
<chargeCodeNonPPMove>true</chargeCodeNonPPMove>
<RegionShortName>Uusimaa</RegionShortName>
<arp>
<tadig>OPA01</tadig>
<assignmentTime>2014-07-23T04:28:02Z</assignmentTime>
</arp>
</SimResource>
</ns2:QuerySimResourceResponse>
</env:Body>
</env:Envelope>

QuerySimResources

With this operation, it is possible to retrieve information about one or multiple SIM resources by entering a valid IMSI, MSISDN, IMEI, ICC, or customer label, and optionally, a range.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

Look at the API migration tutorial Here

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sim="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sim:QuerySimResources>
<resource>
<id>123456789123456</id>
<type>imsi</type>
</resource>
<range>2</range>
</sim:QuerySimResources>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySimResourcesResponse
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<simResource>
<customerLabel>Operator A SIM 000</customerLabel>
<msisdn>1234567891234</msisdn>
<imsi>123456789123456</imsi>
<icc>123456789123</icc>
<pin1>0000</pin1>
<pin2>1111</pin2>
<puk1>00000000</puk1>
<puk2>11111111</puk2>
<imei>123456789123</imei>
<customerNo>00000001</customerNo>
<site></site>
<accessControlClass></accessControlClass>
<roamProfileName>Operator A RP 2</roamProfileName>
<roamProfileDesc>Operator A Roaming Profile 2</roamProfileDesc>
<deviceTerminalType>123456789123</deviceTerminalType>
<simSubscriptionStatus>Ordered</simSubscriptionStatus>
<simResourceStatus>Ordered</simResourceStatus>
<simCardDescription>Operator A SIM Card2_9</simCardDescription>
<productOfferName>Operator A PO 2</productOfferName>
<deliveryDate>2013-12-18T16:54:23.000+01:00</deliveryDate>
<firstActivationDate>2013-12-18T16:54:23.000+01:00</firstActivationDate>
</simResource>
</ns2:QuerySimResourcesResponse>
</env:Body>
</env:Envelope>

QuerySubscriptionChangeBatches

With this operation, it is possible to query the status of a submitted batch request. Batch requests up to two weeks old are returned unless they have been cleared with the RequestSubscriptionChangeBatchClear method.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QuerySubscriptionChangeBatches>
<customerNo>00000001</customerNo>
<requestType>Package</requestType>
</sub:QuerySubscriptionChangeBatches>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionChangeBatchesResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<PendingBatchRow>
<requestId>REQ000000097</requestId>
<requestType>Status</requestType>
<requestStatus>Completed</requestStatus>
<serviceRequestId>REQ000000098</serviceRequestId>
<batchInfo>none</batchInfo>
<validationStatus>Validated</validationStatus>
<detailedValidationStatus>Validated Successfully</detailedValidationStatus>
<batchFile>test.batch</batchFile>
<submitter>[email protected]</submitter>
<submitTime>2014-09-11T00:00:00.000Z</submitTime>
<additionalInfo></additionalInfo>
</PendingBatchRow>
</ns2:QuerySubscriptionChangeBatchesResponse>
</env:Body>
</env:Envelope>

QuerySubscriptionPackageChangeBatch

With this operation, it is possible to query the validation status of the operation for changing the subscription package of a batch of subscriptions.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QuerySubscriptionPackageChangeBatchRequest>
<requestId>REQ000000110</requestId>
</sub:QuerySubscriptionPackageChangeBatchRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:

Failure

<env:Envelope
xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionPackageChangeBatchResponse ⇒
xmlns:ns2='http://iot-api.aeris.net/SubscriptionManagement'>
<requestId>REQ000000110</requestId>
<requestStatus>Completed</requestStatus>
<changeBatchEntry>
<imsi>240081001000000</imsi>
<msisdn></msisdn>
<validationStatus>Failed</validationStatus>
<errorCode>SIM has an error: Could not create Service Request.
Target subscription package A_SP22 is pending processing under
another service request REQ000000051859.</errorCode>
</changeBatchEntry>
</ns2:QuerySubscriptionPackageChangeBatchResponse>
</env:Body>
</env:Envelope>

Success

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionPackageChangeBatchResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<requestId>REQ000000033780</requestId>
<requestStatus>Completed</requestStatus>
<serviceRequestId>REQ000000099</serviceRequestId>
<changeBatchEntry>
<imsi>240081001000000</imsi>
<msisdn></msisdn>
<validationStatus>Validated</validationStatus>
</changeBatchEntry>
</ns2:QuerySubscriptionPackageChangeBatchResponse>
</env:Body>
</env:Envelope>

Partial Success

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionPackageChangeBatchResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<requestId>REQ000000033780</requestId>
<requestStatus>Completed</requestStatus>
<serviceRequestId>REQ000000053536</serviceRequestId>
<changeBatchEntry>
<imsi>310123456015437</imsi>
<msisdn>510123456004002</msisdn>
<validationStatus>Validated</validationStatus>
<errorCode></errorCode>
</changeBatchEntry>
<changeBatchEntry>
<imsi>310123456015324</imsi>
<msisdn>510123456003889</msisdn>
<validationStatus>Validated</validationStatus>
<errorCode></errorCode>
<validationCode>SIM skipped for processing:
Given Subscription(s) is/are pending processing under
another service request REQ000000052571</validationCode>
</changeBatchEntry>
</ns2:QuerySubscriptionPackageChangeBatchResponse>
</env:Body>
</env:Envelope>

QuerySubscriptionPackages

With this operation, it is possible to retrieve a list of valid subscription packages. It lists only those subscription packages to which subscriptions can be assigned.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QuerySubscriptionPackages></sub:QuerySubscriptionPackages>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionPackagesResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<subscriptionPackages>
<subscriptionPackageName>C1P5_subtype_0</subscriptionPackageName>
<serviceContract>C1P5_OPA_1</serviceContract>
</subscriptionPackages>
<subscriptionPackages>
<subscriptionPackageName>C1P5_subtype_3</subscriptionPackageName>
<serviceContract>C1P5_OPA_1</serviceContract>
</subscriptionPackages>
</ns2:QuerySubscriptionPackagesResponse>
</env:Body>
</env:Envelope>

QuerySubscriptionPackages_v2

With this operation, it is possible to retrieve a list of valid subscription packages together with trigger package information. It lists only those subscription packages to which subscriptions can be assigned.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QuerySubscriptionPackagesRequest_v2>
<customerNo>00000001</customerNo>
</sub:QuerySubscriptionPackagesRequest_v2>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionPackagesResponse_v2 ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<subscriptionPackages>
<subscriptionPackageName>C1P5_subtype_0</subscriptionPackageName>
<serviceContract>C1P5_OPA_1</serviceContract>
</subscriptionPackages>
<subscriptionPackages>
<subscriptionPackageName>C1P5_subtype_3</subscriptionPackageName>
<serviceContract>C1P5__1</serviceContract>
<triggerPackageNo>1000266</triggerPackageNo>
</subscriptionPackages>
</ns2:QuerySubscriptionPackagesResponse_v2>
</env:Body>
</env:Envelope>

QuerySubscriptions

With this operation, it is possible to retrieve a collection of subscriptions that match the given search criteria. If no search criterion is given, all of the customers subscriptions are the targets for the search.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QuerySubscriptionsRequest>
<customerNo>000123</customerNo>
<lastSubscriptionPackageChange>
<lastDate>2014-09-11</lastDate>
<filter>After</filter>
</lastSubscriptionPackageChange>
<maxResults>200</maxResults>
</sub:QuerySubscriptionsRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionsResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<subscriptions>
<subscription>
<imsi>123456789123456</imsi>
<msisdn>1234567891234</msisdn>
<customerLabel>sms sim</customerLabel>
<subscriptionPackageName>SP_11 Advanced</subscriptionPackageName>
<lastOperator>lastOperator</lastOperator>
<lastCountry>lastCountry</lastCountry>
</subscription>
<subscription>
<imsi>123456789123456</imsi>
<msisdn>1234567891</msisdn>
<customerLabel>customerLabel2</customerLabel>
<subscriptionPackageName>subscriptionPackage2</subscriptionPackageName>
<lastOperator>lastOperator2</lastOperator>
<lastCountry>lastCountry2</lastCountry>
</subscription>
</subscriptions>
</ns2:QuerySubscriptionsResponse>
</env:Body>
</env:Envelope>

QuerySubscriptionsStatusHistory

With this operation, it is possible to retrieve a list of aggregated status volumes for each selected date.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QuerySubscriptionsStatusHistory>
<customerNo>00000001</customerNo>
<startDate>2016-02-01</startDate>
<endDate>2016-02-08</endDate>
</sub:QuerySubscriptionsStatusHistory>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionsStatusHistoryResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<aggregatedStatus>
<aggregationDate>2013-09-29</aggregationDate>
<aggregatedStatusVolume>
<status>Active</status>
<statusVolume>1542</statusVolume>
</aggregatedStatusVolume>
<aggregatedStatusVolume>
<status>Deactivated</status>
<statusVolume>319</statusVolume>
</aggregatedStatusVolume>
<aggregatedStatusVolume>
<status>Ordered</status>
<statusVolume>2</statusVolume>
</aggregatedStatusVolume>
</aggregatedStatus>
<aggregatedStatus>
<aggregationDate>2013-09-30</aggregationDate>
<aggregatedStatusVolume>
<status>Active</status>
<statusVolume>1542</statusVolume>
</aggregatedStatusVolume>
<aggregatedStatusVolume>
<status>Pause</status>
<statusVolume>10</statusVolume>
</aggregatedStatusVolume>
<aggregatedStatusVolume>
<status>Terminated</status>
<statusVolume>5</statusVolume>
</aggregatedStatusVolume>
</aggregatedStatus>
</ns2:QuerySubscriptionsStatusHistoryResponse>
</env:Body>
</env:Envelope>

QuerySubscriptionStatusChange

With this operation, it is possible to query the status of a requested status change of a SIM subscription.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sim="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sim:QuerySubscriptionStatusChange>
<serviceRequestId>REQ000000001191</serviceRequestId>
</sim:QuerySubscriptionStatusChange>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionStatusChangeResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<serviceRequestId>REQ000000001191</serviceRequestId>
<statusRequestResponse>Pending</statusRequestResponse>
<completedDate>2016-11-18Z</completedDate>
</ns2:QuerySubscriptionStatusChangeResponse>
</env:Body>
</env:Envelope>

QuerySubscriptionStatusChangeBatch

With this operation, it is possible to query the result of the validation part of a requested change of subscription status on a batch of subscriptions.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:QuerySubscriptionStatusChangeBatch>
<requestId>REQ000000110</requestId>
</sub:QuerySubscriptionStatusChangeBatch>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:

Failure

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionStatusChangeBatchResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<requestId>REQ000000110</requestId>
<requestStatus>Completed</requestStatus>
<changeBatchEntry>
<imsi>240081001000000</imsi>
<msisdn></msisdn>
<validationStatus>Validated</validationStatus>
<errorCode>SIM has an error: Same Subscription Status</errorCode>
</changeBatchEntry>
</ns2:QuerySubscriptionStatusChangeBatchResponse>
</env:Body>
</env:Envelope>

Success

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionStatusChangeBatchResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<requestStatus>Completed</requestStatus>
<serviceRequestId>REQ000000099</serviceRequestId>
<changeBatchEntry>
<imsi>240081001000000</imsi>
<msisdn></msisdn>
<validationStatus>Validated</validationStatus>
<errorCode></errorCode>
</changeBatchEntry>
</ns2:QuerySubscriptionStatusChangeBatchResponse>
</env:Body>
</env:Envelope>

Partial Success

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QuerySubscriptionStatusChangeBatchResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<requestId>REQ000000000031798</requestId>
<requestStatus>Completed</requestStatus>
<serviceRequestId>REQ000000099</serviceRequestId>
<changeBatchEntry>
<imsi>240081001000000</imsi>
<msisdn></msisdn>
<validationStatus>Validated</validationStatus>
<errorCode></errorCode>
</changeBatchEntry>
<changeBatchEntry>
<imsi>240081001000000</imsi>
<msisdn></msisdn>
<validationStatus>Validated</validationStatus>
<errorCode></errorCode>
<validationCode>SIM skipped for processing: Same Subscription Status.</validationCode>
</changeBatchEntry>
</ns2:QuerySubscriptionStatusChangeBatchResponse>
</env:Body>
</env:Envelope>

QueryTopCountryTrafficUsage

With this operation, it is possible to retrieve the top countries with most traffic usage. The traffic can be filtered on a specific sub-customer if the user has the authority.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/AggregatedTraffic?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:agg="http://iot-api.aeris.net/AggregatedTraffic">
<soapenv:Header/>
<soapenv:Body>
<agg:QueryTopCountryTrafficUsage>
<customerNo>00000001</customerNo>
<trafficType>SMS</trafficType>
<resultLimit>10</resultLimit>
<startDate>2016-11-01</startDate>
<endDate>2016-11-08</endDate>
</agg:QueryTopCountryTrafficUsage>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryTopCountryTrafficUsageResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/AggregatedTraffic">
<countryTrafficUsageData>
<country>Sweden</country>
<volume>6</volume>
</countryTrafficUsageData>
</ns2:QueryTopCountryTrafficUsageResponse>
</env:Body>
</env:Envelope>

QueryTopSubscriberTrafficUsage

With this operation, it is possible to retrieve the top subscriptions with most traffic usage. The traffic can be filtered on a specific sub-customer if the user has the authority.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/AggregatedTraffic?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:agg="http://iot-api.aeris.net/AggregatedTraffic">
<soapenv:Header/>
<soapenv:Body>
<agg:QueryTopSubscriberTrafficUsage>
<customerNo>00000001</customerNo>
<trafficType>SMS</trafficType>
<resultLimit>5</resultLimit>
<startDate>2013-11-01</startDate>
<endDate>2013-11-08</endDate>
</agg:QueryTopSubscriberTrafficUsage>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryTopSubscriberTrafficUsageResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/AggregatedTraffic">
<subscriberTrafficUsageData>
<imsi>123456789123456</imsi>
<msisdn>1234567891234</msisdn>
<volume>2</volume>
</subscriberTrafficUsageData>
</ns2:QueryTopSubscriberTrafficUsageResponse>
</env:Body>
</env:Envelope>

QueryTriggerAlarms

With this operation, it is possible to retrieve a list of more detailed information about all the active alarms. Up to 100 alarms are returned.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerAlarms?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerAlarms">
<soapenv:Header/>
<soapenv:Body>
<trig:QueryTriggerAlarms>
<customerNo>00000001</customerNo>
<alarmFilter>alertTriggers</alarmFilter>
</trig:QueryTriggerAlarms>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryTriggerAlarmsResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerAlarms">
<alarms>
<alarm>
<id>15</id>
<triggerId>11</triggerId>
<triggerDescription>SMS MO under run per timeframe</triggerDescription>
<imsi>123456789123456</imsi>
<msisdn>123456789123456</msisdn>
<thresholdValue>337</thresholdValue>
<timestamp>2011-12-17T18:16:18.000Z</timestamp>
<alarmType>Information</alarmType>
</alarm>
<alarm>
<id>16</id>
<triggerId>1</triggerId>
<triggerDescription>Location update</triggerDescription>
<imsi>123456789123456</imsi>
<msisdn>123456789123456</msisdn>
<thresholdValue>1</thresholdValue>
<timestamp>2011-12-17T00:48:38.000Z</timestamp>
<alarmType>Deactivation</alarmType>
</alarm>
</alarms>
</ns2:QueryTriggerAlarmsResponse>
</env:Body>
</env:Envelope>

QueryTriggerAlarmsSummary

With this operation, it is possible to retrieve a list of short description summaries and alarm counts.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerAlarms?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerAlarms">
<soapenv:Header/>
<soapenv:Body>
<trig:QueryTriggerAlarmsSummary>
<customerNo>00000001</customerNo>
<alarmFilter>actionTriggers</alarmFilter>
</trig:QueryTriggerAlarmsSummary>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryTriggerAlarmsSummaryResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerAlarms">
<alarmsSummaries>
<alarmsSummary>
<triggerId>11</triggerId>
<description>SMS MO under run per timeframe</description>
<count>1</count>
<latest>2011-12-14T12:52:32.811Z</latest>
</alarmsSummary>
<alarmsSummary>
<triggerId>9</triggerId>
<description>GPRS DL under run per timeframe</description>
<count>2</count>
<latest>2011-12-15T12:52:32.811Z</latest>
</alarmsSummary>
</alarmsSummaries>
</ns2:QueryTriggerAlarmsSummaryResponse>
</env:Body>
</env:Envelope>

QueryTriggerPackages

With this operation, it is possible to query trigger packages.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:QueryTriggerPackagesRequest>
<customerNo>00000001</customerNo>
</trig:QueryTriggerPackagesRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryTriggerPackagesResponse
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<triggerPackages>
<triggerPackage>
<customerNo>00000001</customerNo>
<packageNo>11</packageNo>
<name>Activity Package</name>
<description>Pack description</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>1</triggerNumber>
<triggerName>No location update</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>2</triggerNumber>
<triggerName>Roaming not allowed</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>5</triggerNumber>
<triggerName>PDP Context Activation attempts per timeframe</triggerName>
<timeFrame>2</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
<lastChange>2011-04-29Z</lastChange>
</triggerMetric>
<triggerMetric>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<timeFrame>4</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
<lastChange>2011-04-29Z</lastChange>
</triggerMetric>
<triggerMetric>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>10</triggerNumber>
<triggerName>SMS MO over run per timeframe</triggerName>
<timeFrame>11</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
<lastChange>2011-04-29Z</lastChange>
</triggerMetric>
<triggerMetric>
<triggerNumber>11</triggerNumber>
<triggerName>SMS MO under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>12</triggerNumber>
<triggerName>SMS MT over run per timeframe</triggerName>
<timeFrame>11</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
<lastChange>2011-04-29Z</lastChange>
</triggerMetric>
<triggerMetric>
<triggerNumber>13</triggerNumber>
<triggerName>SMS MT under run per timeframe</triggerName>
<timeFrame></timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>14</triggerNumber>
<triggerName>Net activity under run per timeframe</triggerName>
<timeFrame>22</timeFrame>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
<lastChange>2011-04-29Z</lastChange>
</triggerMetric>
</triggerMetrics>
</triggerPackage>
</triggerPackages>
</ns2:QueryTriggerPackagesResponse>
</env:Body>
</env:Envelope>

QueryTriggerPackages_v2

With this operation, it is possible to query a list of trigger packages. The V2 versions of the TriggerPackageManagement operations support selectable time unit and must be used with long-term triggers.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:QueryTriggerPackagesRequest_v2>
<customerNo>00000001</customerNo>
</trig:QueryTriggerPackagesRequest_v2>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryTriggerPackagesResponse_v2 ⇒
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<triggerPackages>
<triggerPackage>
<customerNo>00000001</customerNo>
<packageNo>11</packageNo>
<name>Activity Package</name>
<description>Pack description</description>
<triggerMetrics>
<triggerMetric>
<triggerNumber>1</triggerNumber>
<triggerName>No location update</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>2</triggerNumber>
<triggerName>Roaming not allowed</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>5</triggerNumber>
<triggerName>PDP Context Activation attempts per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>7</triggerNumber>
<triggerName>GPRS Long term over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>9</triggerNumber>
<triggerName>SMS MO Long term over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>10</triggerNumber>
<triggerName>SMS MO over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>11</triggerNumber>
<triggerName>SMS MO under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>12</triggerNumber>
<triggerName>SMS MT over run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>13</triggerNumber>
<triggerName>SMS MT under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>14</triggerNumber>
<triggerName>Net activity under run per timeframe</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>15</triggerNumber>
<triggerName>GPRS Long term Network Group 1</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>16</triggerNumber>
<triggerName>GPRS Long term Network Group 2</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>17</triggerNumber>
<triggerName>GPRS Long term other networks</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>18</triggerNumber>
<triggerName>SMS MO Long term Network Group 1</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>19</triggerNumber>
<triggerName>SMS MO Long term Network Group 2</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
<triggerMetric>
<triggerNumber>20</triggerNumber>
<triggerName>SMS MO Long term other networks</triggerName>
<alertActive>false</alertActive>
<alertValue></alertValue>
<actionActive>false</actionActive>
<actionValue></actionValue>
</triggerMetric>
</triggerMetrics>
</triggerPackage>
</triggerPackages>
</ns2:QueryTriggerPackagesResponse_v2>
</env:Body>
</env:Envelope>

QueryTriggers

With this operation, it is possible to query the available triggers.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:QueryTriggersRequest></trig:QueryTriggersRequest>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryTriggersResponse
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<triggers>
<trigger>
<triggerNumber>1</triggerNumber>
<triggerName>No location update</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>false</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<triggerType>Underrun</triggerType>
<lastChange>2014-10-28Z</lastChange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<minValue>1</minValue>
<maxValue>4000000000</maxValue>
</trigger>
<trigger>
<triggerNumber>2</triggerNumber>
<triggerName>Roaming not allowed</triggerName>
<timeFrameAllowed>false</timeFrameAllowed>
<alertThresholdValueAllowed>false</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<triggerType>Overrun</triggerType>
<lastChange>2014-10-28Z</lastChange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<minValue>1</minValue>
<maxValue>4000000000</maxValue>
</trigger>
<trigger>
<triggerNumber>5</triggerNumber>
<triggerName>PDP Context Activation attempts per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2014-10-28Z</lastChange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<minValue>1</minValue>
<maxValue>4000000000</maxValue>
</trigger>
<trigger>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>bytes</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2014-10-28Z</lastChange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<minValue>1</minValue>
<maxValue>4000000000</maxValue>
</trigger>
</triggers>
</ns2:QueryTriggersResponse>
</env:Body>
</env:Envelope>

QueryTriggers_v2

With this operation, it is possible to query available triggers. The V2 versions of the TriggerPackageManagement operations support selectable time unit and must be used with long-term triggers.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/TriggerPackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trig="http://iot-api.aeris.net/TriggerPackageManagement">
<soapenv:Header/>
<soapenv:Body>
<trig:QueryTriggersRequest_v2></trig:QueryTriggersRequest_v2>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryTriggersResponse_v2
xmlns:ns2="http://iot-api.aeris.net/TriggerPackageManagement">
<triggers>
<triggerNumber>1</triggerNumber>
<triggerName>No location update</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>false</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<triggerType>Underrun</triggerType>
<lastChange>2014-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>2</triggerNumber>
<triggerName>Roaming not allowed</triggerName>
<timeFrameAllowed>false</timeFrameAllowed>
<alertThresholdValueAllowed>false</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<triggerType>Overrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>5</triggerNumber>
<triggerName>PDP Context Activation attempts per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>6</triggerNumber>
<triggerName>GPRS Short term over run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>bytes</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>7</triggerNumber>
<triggerName>GPRS Long term over run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>bytes</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>4</maxTimeFrameValue>
<timeFrameUnit>week</timeFrameUnit>
</timeFrameRange>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>1</maxTimeFrameValue>
<timeFrameUnit>month</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>8</triggerNumber>
<triggerName>GPRS Short term under run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<thresholdUnit>bytes</thresholdUnit>
<triggerType>Underrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>9</triggerNumber>
<triggerName>SMS MO Long term over run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<thresholdUnit>bytes</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>4</maxTimeFrameValue>
<timeFrameUnit>week</timeFrameUnit>
</timeFrameRange>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>1</maxTimeFrameValue>
<timeFrameUnit>month</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>10</triggerNumber>
<triggerName>SMS MO over run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>11</triggerNumber>
<triggerName>SMS MO under run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Underrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>12</triggerNumber>
<triggerName>SMS MT over run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>13</triggerNumber>
<triggerName>SMS MT under run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Underrun</triggerType>
<lastChange>2009-10-28Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>14</triggerNumber>
<triggerName>Net activity under run per timeframe</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>false</alertThresholdValueAllowed>
<actionThresholdAllowed>false</actionThresholdAllowed>
<triggerType>Underrun</triggerType>
<lastChange>2010-10-22Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>48</maxTimeFrameValue>
<timeFrameUnit>hour</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>15</triggerNumber>
<triggerName>GPRS Long term Network Group 1</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>bytes</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2013-02-18Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>4</maxTimeFrameValue>
<timeFrameUnit>week</timeFrameUnit>
</timeFrameRange>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>1</maxTimeFrameValue>
<timeFrameUnit>month</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>16</triggerNumber>
<triggerName>GPRS Long term Network Group 2</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>bytes</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2013-02-18Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>4</maxTimeFrameValue>
<timeFrameUnit>week</timeFrameUnit>
</timeFrameRange>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>1</maxTimeFrameValue>
<timeFrameUnit>month</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>17</triggerNumber>
<triggerName>GPRS Long term other networks</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>bytes</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2013-02-18Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>4</maxTimeFrameValue>
<timeFrameUnit>week</timeFrameUnit>
</timeFrameRange>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>1</maxTimeFrameValue>
<timeFrameUnit>month</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>18</triggerNumber>
<triggerName>SMS MO Long term Network Group 1</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2013-02-18Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>4</maxTimeFrameValue>
<timeFrameUnit>week</timeFrameUnit>
</timeFrameRange>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>1</maxTimeFrameValue>
<timeFrameUnit>month</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>19</triggerNumber>
<triggerName>SMS MO Long term Network Group 2</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2013-02-18Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>4</maxTimeFrameValue>
<timeFrameUnit>week</timeFrameUnit>
</timeFrameRange>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>1</maxTimeFrameValue>
<timeFrameUnit>month</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
<triggers>
<triggerNumber>20</triggerNumber>
<triggerName>SMS MO Long term other networks</triggerName>
<timeFrameAllowed>true</timeFrameAllowed>
<alertThresholdValueAllowed>true</alertThresholdValueAllowed>
<actionThresholdAllowed>true</actionThresholdAllowed>
<thresholdUnit>pcs</thresholdUnit>
<triggerType>Overrun</triggerType>
<lastChange>2013-02-18Z</lastChange>
<timeFrameRanges>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>4</maxTimeFrameValue>
<timeFrameUnit>week</timeFrameUnit>
</timeFrameRange>
<timeFrameRange>
<minTimeFrameValue>1</minTimeFrameValue>
<maxTimeFrameValue>1</maxTimeFrameValue>
<timeFrameUnit>month</timeFrameUnit>
</timeFrameRange>
</timeFrameRanges>
<minValue>1</minValue>
<maxValue>9999999999</maxValue>
</triggers>
</ns2:QueryTriggersResponse_v2>
</env:Body>
</env:Envelope>

RealtimeTrace

This service makes it possible to trace traffic for resources in real time.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/RealtimeTrace?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:trac="http://iot-api.aeris.net/RealtimeTrace">
<soapenv:Header/>
<soapenv:Body>
<trac:Query>
<traceLength>3</traceLength>
<filter>
<resourceFilter>
<resourceType>IMSI</resourceType>
<resourceId>123456789123456</resourceId>
<range>5</range>
</resourceFilter>
</filter>
</trac:Query>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:trac="http://iot-api.aeris.net/RealtimeTrace">
<soapenv:Header/>
<soapenv:Body>
<trac:Query>
<traceLength>3</traceLength>
<filter>
<eventFilter>
<countryCode>SE</countryCode>
</eventFilter>
</filter>
</trac:Query>
</soapenv:Body>
</soapenv:Envelope>

Reconnect

The Device Reconnect function is used to reset the subscription location data in the mobile network. This can resolve problems in the network, and allow a device to reconnect.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/DeviceReconnect?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"⇒
xmlns:dev="http://iot-api.aeris.net/DeviceReconnect">
<soapenv:Header/>
<soapenv:Body>
<dev:Reconnect>
<resource>
<id>240081001000000</id>
<type>imsi</type>
</resource>
</dev:Reconnect>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:ReconnectResponse
xmlns:ns2="http://iot-api.aeris.net/DeviceReconnect"/>
</env:Body>
</env:Envelope>

ReportDownload

With this operation, it is possible to retrieve a list of report data files that can be downloaded.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/ReportDownload?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:rep="http://iot-api.aeris.net/reportdownload">
<soapenv:Header/>
<soapenv:Body>
<rep:Query>
<reporttype>CBDETRPT</reporttype>
<fromdate>2014-04-02</fromdate>
<todate>2014-04-18</todate>
</rep:Query>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryResponse
xmlns:ns2="http://iot-api.aeris.net/reportdownload">
<report>
<url>/api/reportdata?id=1234476899934:Std</url>
<reportDate>2014-04-11T00:00:00.000Z</reportDate>
<size>12452</size>
<reportType>CBDETRPT</reportType>
<reportPeriod>2014-04</reportPeriod>
</report>
</ns2:QueryResponse>
</env:Body>
</env:Envelope>

RequestCustomerLabelChange

With this operation, it is possible to request changing a customer label. The request returns a registered serviceRequestId meaning that the actual change can occur at a later time.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:RequestCustomerLabelChange>
<customerLabel>CustomerLabel</customerLabel>
<resource>
<id>123456789123456</id>
<type>msisdn</type>
</resource>
<range>1</range>
</sub:RequestCustomerLabelChange>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:RequestCustomerLabelChangeResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<serviceRequestId>REQ000000004741</serviceRequestId>
</ns2:RequestCustomerLabelChangeResponse>
</env:Body>
</env:Envelope>

RequestSubscriptionChangeBatchClear

With this operation, it is possible to clear submitted batch requests so they are no longer returned by the QuerySubscriptionChangeBatches method in future queries.

IMPORTANT! This SOAP API will be deprecated.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:RequestSubscriptionChangeBatchClear>
<requestId>REQ000000061</requestId>
</sub:RequestSubscriptionChangeBatchClear>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:

Failure

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<env:Fault
xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
<faultcode
xmlns:codeNS="http://iot-api.aeris.net/error">codeNS:ResourceNotFound
</faultcode>
<faultstring>Resource not found</faultstring>
<detail>
<cnx:faultid
xmlns:cnx="http://iot-api.aeris.net/error">hlL78RJ3VL
</cnx:faultid>
</detail>
</env:Fault>
</env:Body>
</env:Envelope>

Success

<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:RequestSubscriptionChangeBatchClearResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<requestId>REQ000000099</requestId>
</ns2:RequestSubscriptionChangeBatchClearResponse>
</env:Body>
</env:Envelope>

RequestSubscriptionPackageChange

With this operation, it is possible to request changing the subscription package for an individual SIM resource or for a range of SIMs. The request returns a registered serviceRequestId meaning that the actual change can occur at a later time.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:RequestSubscriptionPackageChange>
<resource>
<id>1234567891234</id>
<type>msisdn</type>
</resource>
<range>2</range>
<subscriptionPackage>C1P5_subtype_0</subscriptionPackage>
<customerNo>00000001</customerNo>
</sub:RequestSubscriptionPackageChange>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:RequestSubscriptionPackageChangeResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<serviceRequestId>REQ000000110</serviceRequestId>
</ns2:RequestSubscriptionPackageChangeResponse>
</env:Body>
</env:Envelope>

RequestSubscriptionPackageChangeBatch

With this operation, it is possible to change the subscription package of a batch of subscriptions. The batch can contain up to 10.000 subscriptions. The operation performs a validation check on the batch. Any subscription failing validation is skipped, and the next subscription is checked. All validation failures are registered. After the validation has finished, the operation returns a registered requestId meaning that the actual change can occur at a later time.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:RequestSubscriptionPackageChangeBatch>
<resources>
<resourceIdList>
<!--1 to 10000 repetitions:-->
<id>123456789123</id>
</resourceIdList>
<resourceType>msisdn</resourceType>
</resources>
<subscriptionPackage>C1P5_subtype_0</subscriptionPackage>
<customerNo>00000001</customerNo>
<batchFile>my_sims.bat</batchFile>
<additionalInfo>Batch request ordered by John Doe</additionalInfo>
</sub:RequestSubscriptionPackageChangeBatch>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:RequestSubscriptionPackageChangeBatchResponse ⇒
xmlns:ns2="http:/iot-api.aeris.net/SubscriptionManagement">
<requestId>REQ000000000000189</requestId>
</ns2:RequestSubscriptionPackageChangeBatchResponse>
</env:Body>
</env:Envelope>

RequestSubscriptionStatusChange

With this operation, it is possible to request a change on SIM resource subscription status. The request returns a registered serviceRequestId meaning that the actual change can occur at a later time. Use the QuerySubscriptionStatusChange method to check the status of the request.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

EXAMPLE OF API REQUEST:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sim="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sim:RequestSubscriptionStatusChange>
<resource>
<id>1234567891234</id>
<type>msisdn</type>
</resource>
<subscriptionStatus>Activate</subscriptionStatus>
<range>2</range>
</sim:RequestSubscriptionStatusChange>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:RequestSubscriptionStatusChangeResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<serviceRequestId>REQ000000001120</serviceRequestId>
</ns2:RequestSubscriptionStatusChangeResponse>
</env:Body>
</env:Envelope>

RequestSubscriptionStatusChangeBatch

With this operation, it is possible to request a change of subscription status using a batch of subscriptions. The batch file can contain up to 10.000 subscriptions and they can belong to different subscription packages. The request returns a registered requestId meaning that the actual change can occur at a later time. This batch operation can only be successful if the operation is successful for every subscription that compounds the batch. Use the QuerySubscriptionChangeBatches and QuerySubscriptionStatusChangeBatch operations to check status of the request.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/SubscriptionManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:RequestSubscriptionStatusChangeBatch>
<resources>
<resourceIdList>
<id>240081001000000</id>
<id>240081001000012</id>
</resourceIdList>
<resourceType>imsi</resourceType>
</resources>
<subscriptionStatus>Activate</subscriptionStatus>
</sub:RequestSubscriptionStatusChangeBatch>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:RequestSubscriptionStatusChangeBatchResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/SubscriptionManagement">
<requestId>REQ000000000189</requestId>
</ns2:RequestSubscriptionStatusChangeBatchResponse>
</env:Body>
</env:Envelope>

RequestUnblockSubscription

With this operation, it is possible to activate a SIM subscription status that was deactivated because of overconsumption of SMS or GPRS traffic. The request returns a registered serviceRequestId meaning that the actual change can occur at a later time.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/BundlePackageManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:sub="http://iot-api.aeris.net/BundlePackageManagement">
<soapenv:Header/>
<soapenv:Body>
<sub:RequestUnblockSubscription>
<customerNo>99000010</customerNo>
<resource>
<id>240081020000014</id>
<type>imsi</type>
</resource>
</sub:RequestUnblockSubscription>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:RequestUnblockSubscriptionResponse ⇒
xmlns:ns2="http://iot-api.aeris.net/RequestUnblockSubscription">
<serviceRequestId>REQ000000098</serviceRequestId>
</ns2:RequestUnblockSubscriptionResponse>
</env:Body>
</env:Envelope>

ServiceRequestAddActivity

With this operation, it is possible to add an activity to any raised service request that belongs to one of the following request types:
— Request Customer Setup
— Request Customer Termination
— Request Company Details Change

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/ServiceRequestManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:ser="http://iot-api.aeris.net/ServiceRequestManagement">
<soapenv:Header/>
<soapenv:Body>
<ser:ServiceRequestAddActivity>
<serviceRequestId>REQ000000031034</serviceRequestId>
<activitySummary>example error</activitySummary>
<activityNotes>the attached pictures show the process</activityNotes>
<attachments>
<!--1 to 3 repetitions:-->
<attachment>
<fileName>step1</fileName>
<attachmentData>cid:337141689144</attachmentData>
</attachment>
<attachment>
<fileName>step2</fileName>
<attachmentData>cid:337141689145</attachmentData>
</attachment>
<attachment>
<fileName>error</fileName>
<attachmentData>cid:337141689146</attachmentData>
</attachment>
</attachments>
</ser:ServiceRequestAddActivity>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:ServiceRequestAddActivityResponse
xmlns:ns2=
"http://iot-api.aeris.net/ServiceRequestManagement">
<serviceRequestId>REQ000000030815</serviceRequestId>
</ns2:ServiceRequestAddActivityResponse>
</env:Body>
</env:Envelope>

SubscriptionTraffic

This service returns traffic information for resources on the network. The information consists of ID, location update, PDP, and SMS related data.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/SubscriptionTraffic?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:quer="http://iot-api.aeris.net/SubscriptionTraffic">
<soapenv:Header/>
<soapenv:Body>
<quer:Query>
<resource>
<id>123456789123456</id>
<type>imsi</type>
</resource>
<range>1</range>
</quer:Query>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryResponse
xmlns:ns2="http://iot-api.aeris.net/SubscriptionTraffic">
<traffic>
<returnCode>0</returnCode>
<imsi>123456789123456</imsi>
<msisdn>1234567891234</msisdn>
<imei>123456789101112</imei>
<sessionStart>2013-09-30T06:51:34.000Z</sessionStart>
<lastLu>
<status>0</status>
<gprsStatus>0</gprsStatus>
<timestamp>2013-09-30T06:51:34.000Z</timestamp>
<countryCode>SE</countryCode>
<operatorCode>0000</operatorCode>
<vlrGt>35385nnnnnnn</vlrGt>
</lastLu>
<gprs>
<pdpActive>true</pdpActive>
<activation>2013-09-30T06:51:34.000Z</activation>
<ip>192.168.10.73</ip>
<giDestAddress>10.11.2.1</giDestAddress>
<apn>internet.opa.xx</apn>
<tx>42.0</tx>
<lastTx>2013-09-30T06:51:34.000Z</lastTx>
<rx>2.0</rx>
<lastRx>2013-09-30T06:51:34.000Z</lastRx>
</gprs>
<smsMo>
<count>31</count>
<lastDest>1234567891234</lastDest>
<lastSms>2013-09-30T06:51:34.000Z</lastSms>
<smsErrorCount>2</smsErrorCount>
</smsMo>
<smsMt>
<count>4</count>
<lastSms>2013-09-30T06:51:34.000Z</lastSms>
<smsErrorCount>4</smsErrorCount>
</smsMt>
<lastActivity>2013-10-08T09:27:12.000Z</lastActivity>
<lastSmsErrorTime>2013-10-06T08:50:55.000Z</lastSmsErrorTime>
<lastSmsError>Error message</lastSmsError>
<customerNo>00000001</customerNo>
</traffic>
</ns2:QueryResponse>
</env:Body>
</env:Envelope>

IncidentManagement - SummaryQuery

With this operation, it is possible to retrieve incidents matching specified conditions.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.
Please use this REST API instead.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/IncidentManagement?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
<soapenv:Header/>
<soapenv:Body>
<inc:SummaryQuery>
<requestID>REQ000000001387</requestID>
</inc:SummaryQuery>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
<soapenv:Header/>
<soapenv:Body>
<inc:SummaryResponse>
<!--Zero or more repetitions:-->
<responseData>
<serviceRequestID>REQ000000002319</serviceRequestID>
<summary>Log Incident</summary>
<status>PLANNING</status>
<submitDate>2013-11-16T14:00:39.000Z</submitDate>
<company></company>
<site>Enterprise A Site</site>
<region>Region A</region>
<siteGroup>SiteGroup B</siteGroup>
<requesterFirstName>Example</requesterFirstName>
<requesterLastName>User</requesterLastName>
<assignedGroup>Service Desk</assignedGroup>
<assignee>Support User</assignee>
<targetFixTime>2013-11-17T14:00:38.000Z</targetFixTime>
<urgency>2-High</urgency>
<impact>4-Minor/Localized</impact>
<categoryLevel1>Access</categoryLevel1>
<lastModifiedDate>2013-11-17T09:24:51.000Z</lastModifiedDate>
</responseData>
</inc:SummaryResponse>
</soapenv:Body>
</soapenv:Envelope>

Or (Summary Response including incidentID)

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ⇒
xmlns:inc="http://iot-api.aeris.net/IncidentManagement">
<soapenv:Header/>
<soapenv:Body>
<inc:SummaryResponse>
<!--Zero or more repetitions:-->
<responseData>
<incidentID>INC000000000225</incidentID>
<summary>Log Incident</summary>
<status>PLANNING</status>
<submitDate>2013-11-16T14:00:39.000Z</submitDate>
<company></company>
<site>Site A</site>
<region>Region B</region>
<siteGroup>SiteGroup B</siteGroup>
<requesterFirstName>Example</requesterFirstName>
<requesterLastName>User</requesterLastName>
<assignedGroup>Service Desk</assignedGroup>
<assignee>Support User</assignee>
<targetFixTime>2013-11-17T14:00:38.000Z</targetFixTime>
<urgency>2-High</urgency>
<impact>4-Minor/Localized</impact>
<categoryLevel1>Access</categoryLevel1>
<lastModifiedDate>2013-11-17T09:24:51.000Z</lastModifiedDate>
</responseData>
</inc:SummaryResponse>
</soapenv:Body>
</soapenv:Envelope>

QueryCountries

With this operation, it is possible to retrieve a list of all available countries with corresponding code.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/OperatorInfo?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:oper="http://iot-api.aeris.net/OperatorInfo">
<soapenv:Header/>
<soapenv:Body>
<oper:QueryCountries></oper:QueryCountries>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryCountryCodeResponse
xmlns:ns2="http://iot-api.aeris.net/OperatorInfo">
<country>
<name>Sweden
</Name>
<code>SE</code>
</country>
<country>
<name>Norway
</Name>
<code>NO</code>
</country>
</ns2:QueryCountryCodeResponse>
</env:Body>
</env:Envelope>

QueryOperators

With this operation, it is possible to retrieve a list of all available operators corresponding operator and country codes.

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/OperatorInfo?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" <soapenv:Header/>
<soapenv:Body> <oper:QueryOperators></oper:QueryOperators> </soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryOperatorCodeResponse
xmlns:ns2="http://iot-api.aeris.net/OperatorInfo">
<operator>
<name>Operator A</name>
<code>24299</code>
<countryCode>NO</countryCode>
<countryName>Norway<\countryName>
<callingCode>+47<\callingCode>
</operator>
<operator>
<name>Operator B</name>
<code>24099</code>
<countryCode>SE</countryCode>
<countryName>Sweden<\countryName>
<callingCode>+46<\callingCode>
</operator>
</ns2:QueryOperatorCodeResponse>
</env:Body>
</env:Envelope>

UsageDataDownload

This service makes it possible to download usage data (SMS CDR, GPRS CDR, and TAP records) stored in the Data Warehouse.

IMPORTANT! This SOAP API has a REST replacement which we strongly suggest as alternative.

IoT Accelerator REST API

The WSDL is available at the following URL, where the <baseURI> parameter is provided by the operator:

— <baseURI>/dcpapi/UsageDataDownload?wsdl

EXAMPLE OF API REQUEST:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:usag="http://iot-api.aeris.net/UsageDataDownload">
<soapenv:Header/>
<soapenv:Body>
<usag:Query>
<customerno>00000001</customerno>
<startdate>2016-11-27</startdate>
<enddate>2016-11-30</enddate>
</usag:Query>
</soapenv:Body>
</soapenv:Envelope>
EXAMPLE OF API RESPONSE:
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:QueryResponse
xmlns:ns2="http://iot-api.aeris.net/UsageDataDownload">
<usageData>
<date>2016-11-28T22:00:00.000Z</date>
<size>3404</size>
<path>/api/usagedata?id=1234567800000</path>
</usageData>
<usageData>
<date>2016-11-29T22:00:00.000Z</date>
<size>2305</size>
<path>/api/usagedata?id=1234560000000</path>
</usageData>
</ns2:QueryResponse>
</env:Body>
</env:Envelope>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.