IoT Accelerator SOAP API
This section describes the SOAP APIs exposed by the IoT Accelerator.
| IMPORTANT NOTE: As announced in release 22A1, the SOAP APIs will be deprecated soon, in favour of the most modern REST APIs. For this reason, we strongly recommend to use REST API for your integrations, when applicable. You will find the REST API alternative mentioned as clickable link in this list. In the description page of every SOAP API which has already a proper REST replacement you will find the same "REST replacement" link. |
Please refer to this link to get the latest information on deprecation plan (This link is only accessible by CSP).
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. |
| 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. |
| 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. |
| RealtimeTrace |
Download WSDL |
| RealtimeTrace |
This service makes it possible to trace traffic for a resource in real time. |
| OperatorInfo |
Download WSDL |
| QueryCountries | With this operation, it is possible to retrieve a list of all available countries with corresponding code. |
| QueryOperators | With this operation, it is possible to retrieve a list of all available operators corresponding operator and country codes. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| QuerySubscriptionStatusChange |
With this operation, it is possible to query the status of a requested status change of a SIM subscription. |
| QuerySubscriptionsStatusHistory |
With this operation, it is possible to retrieve a list of aggregated status volumes for each selected date. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| QueryAvailableRegions |
With this operation, it is possible to retrieve the available regions for a single subscription. |
| ChangeSubscriptionRegion |
With this operation, it is possible to change the region for a single subscription. |
| 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. |
| ReportDownload |
Download WSDL |
| ReportDownload | With this operation, it is possible to retrieve a list of report data files that can be downloaded. |
| QueryInvoices | With this operation, it is possible to retrieve a list of invoice data files that can be downloaded. |
| DeleteInvoices | With this operation, it is possible to delete an invoice file using its invoiceName. |
| IncidentManagement |
Download WSDL |
| SummaryQuery |
With this operation, it is possible to retrieve incidents matching specified conditions. |
| Details | With this operation, it is possible to retrieve additional details for a single incident service request. |
| LogIncident | With this operation, it is possible to raise an incident request. |
| LogIncidentActivity | With this operation, it is possible add an activity to a raised incident. |
| QueryCompanySiteDetails | With this operation, it is possible to retrieve available company site details. |
| QueryIncidentCategoryList | With this operation, it is possible to retrieve the list of available categories. |
| QueryIncidentAttachments | With this operation, it is possible retrieve a list of the incident attachments. |
| OverallStatus |
Download WSDL |
| GetStatus | With this operation, it is possible to retrieve a status number for each of the services. |
| TriggerAlarms |
Download WSDL |
| QueryTriggerAlarmsSummary | With this operation, it is possible to retrieve a list of short description summaries and alarm counts. |
| 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. |
| ClearAlarmStatus | With this operation, it is possible to set the status of one or more alarms to cleared. |
| TriggerPackageManagement |
Download WSDL |
| CreateTriggerPackage | With this operation, it is possible to create a new trigger package. |
| ChangeTriggerPackage | With this operation, it is possible to change a trigger package. |
| DeleteTriggerPackage | With this operation, it is possible to delete a trigger package. |
| QueryTriggerPackages | With this operation, it is possible to query trigger packages. |
| QueryCustomerEmailAddress | With this operation, it is possible to query the e-mail addresses that are subscribed to trigger notifications. |
| 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. |
| AddTriggerPackageToSubscriptionPackages | With this operation, it is possible to assign a trigger package to subscription packages. |
| DeleteTriggerPackageFromSubscriptionPackages | With this operation, it is possible to remove a trigger package from the specified subscription packages. |
| QueryTriggers | With this operation, it is possible to query the available triggers. |
| 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. |
| 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. |
| 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. |
| 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. |
| QueryNetworkGroups | With this operation, it is possible to query network groups. |
| 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. |
| 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. |
| ServiceRequestManagement |
Download WSDL |
| QueryServiceRequests | With this operation, it is possible to retrieve the submitted service requests. |
| QueryServiceRequestActivities | With this operation, it is possible to retrieve the activity details of a particular service request. |
| 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. |
| QueryServiceRequestAttachments | With this operation, it is possible retrieve the service request attachments list. |
| 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. |