Introduction

In this section, you will find a Quick Start Guide that will help you understand the basic process and assist you in getting started with building your application.

The next section of this page contains all available API Endpoints that you can use.
Each endpoint has its own optional and/or required parameters.

Often, pagination is available; please use pagination to avoid retrieving large amounts of response data when it is not needed.

Tips

Check out the Advanced Query Parameters to narrow down the number of responses returned in your request.

The Quick Start Guide will guide you through the process of setting up a new SIM card for your customer and making basic changes.

---

Running Queries

A typical response you receive when sending an API request will look like this:

{
    "offset": 0,
    "total": 3,
    "results": [
       {
            "id": "RMB####zFPs##udq",
            "subscriptionId": "za4####ugfn##biN",
            "detailonsomething" : [{
                "description": "",
                "etc": "etc"
            }]
        }
    ],
    "meta": {}
}

Info

As you can see, the response can contain an object with several nested objects. Below is a brief description of the most important object:

Root Object

• offset (integer): The number of skipped records (set by the skip parameter in the API call).
• total (integer): The total number of records.
• results (array): A list of results in response of your request.
• meta (object): Additional metadata.
• responseStatus (object): The status of the API response (only included when an error occurs due to invalid or missing data in the request).

Carefull

The displayed value for the total field is not always calculated correctly.
We are planning on resolving this issue in the future.

---

The Activation Object

For every change request you do, an Activation record is created.
This record is updated whenever the status of your request changes. You can retrieve the current status of all records, or a specific record, using the QueryActivation API call.

So when you use one of the API calls to have something changed, a record is added with a specific activationType related to the requested change.

Table activationType

Code	API Call
ACTIVATENEW	NewSubscription
SUSPEND	SuspendSubscription
SIMSWAP	SimSwapSubscription
SETSERVICES	SetServicesSubscription
INPORT	InPortSubscription
OUTPORT	OutPortSubscription
TERMINATE	TerminateSubscription

---