QueryActivation

Overview

• Method: GET
• Endpoint: /api/QueryActivation
• Description: Retrieves information about activation requests based on specified criteria.

GET /api/QueryActivation

---

Query Parameters

You can refine the search using the following optional parameters:

• id (string, optional): Filter by activation request ID.
• status (string, optional): Filter by activation status (BUSY, DONE, ERROR).
• activationType (string, optional): Filter by activation type (e.g., ACTIVATENEW, etc, see all).
• subscriptionId (string, optional): Filter by associated subscription ID.
• phoneNumber (string, optional): Filter by associated phone number.
• createdAtFrom (string, optional): Start date of creation period (ISO 8601: YYYY-MM-DD).
• createdAtTo (string, optional): End date of creation period (ISO 8601: YYYY-MM-DD).
• take (integer, optional): Number of results to return (pagination).
• skip (integer, optional): Number of results to skip (pagination).
• orderBy / orderByDesc (string, optional): Sorting criteria.

---

Response Structure

The API returns an array of activation records, each containing the following fields:

{
    "offset": 0,
    "total": 67,
    "results": [
        {
            "id": "###gxhI5###Zvz9Js",
            "createdAt": "2025-01-30T15:57:19.93+01:00",
            "modifiedAt": "2025-01-30T15:57:19.93+01:00",
            "status": "BUSY",
            "activationType": "ACTIVATENEW",
            "referenceNumber": "Test ###",
            "providerOrderNumber": "0##290#####25",
            "subscriptionId": "###mPuAf###WJmSPv",
            "info": {
                "simCardNumber": "89310836########76",
                "eSim": false,
                "subscriptionType": "VOICEDATA",
                "accessType": "INTERNETACCESS",
                "customerId": "###A1",
                "stnCustomerId": "###Sc3iA###MQCmA89",
                "wishDate": "2025-02-01T00:00:00+01:00"
            }
        }
    ],
    "meta": {}
}

Field Descriptions

• id: A unique identifier for the activation request.
• createdAt: The date and time when the activation request was created (ISO 8601 datetime format).
• modifiedAt: The date and time when the activation request was last modified (ISO 8601 datetime format).
• status: The current status of the activation request.
  • BUSY: The activation request is being processed.
  • DONE: The activation request has been successfully completed.
  • ERROR: The activation request has failed.
• activationType: The type of activation that was requested (e.g., ACTIVATENEW, etc, see all).
• providerOrderNumber: The ordernummer which the service provider assigned to this request.
• subscriptionId: The ID of the associated subscription.
• phoneNumber: The phone number associated with the activation request.
• activatedDate: The date and time when the activation was completed (if applicable).
• info: Additional details about the activation request, such as:
  • simCardNumber: The SIM card number linked to the activation.
  • eSim: Indicates whether the activation is for an eSIM.
  • subscriptionType: Defines whether the subscription includes voice and data (VOICEDATA) or only data (DATAONLY).
  • accessType: Specifies the type of internet access provided.
  • customerId: The customer’s unique identifier.
  • stnCustomerId: The STN-specific customer identifier.
  • wishDate: The requested activation date.

Info

Returned fields may vary depending on the activation type and status.

KEEP IN MIND

The providerOrderNumber field will only appear in the response after our server has contacted the service provider and received this order number in return. If no response has been received yet, if an error occurred, or if your request was rejected due to validation rules, this field will not be included in the activation object.

---

Usage Notes

• Use this endpoint to retrieve details about one or more activation requests.
• Apply filters to retrieve specific activation records efficiently.
• The status field will always contain one of the following values: BUSY, DONE, or ERROR.
• The activationType field indicates the type of activation that was requested.
• Use pagination (take and skip) to manage large result sets.
• Sorting options (orderBy and orderByDesc) allow ordering results by specific fields.
• Ensure createdAtFrom and createdAtTo follow the ISO 8601 format (YYYY-MM-DD).

SERVICE REQUESTS

In case you might need to have to get in contact with the Service Provider to discuss about a problem (or the state of an assignment/request) use the providerOrderNumber to refer to a specific order.

---

Example Requests

Retrieve information for a specific activation request

GET /api/QueryActivation?id=ACT123456

Get the last 50 completed activation requests, sorted by creation date

GET /api/QueryActivation?status=DONE&take=50&orderByDesc=createdAt

Find all pending SIM swap requests

GET /api/QueryActivation?status=BUSY&activationType=SIMSWAP

Retrieve activation requests created within a specific date range

GET /api/QueryActivation?createdAtFrom=2023-01-01&createdAtTo=2023-12-31

---

Summary

The /api/QueryActivation endpoint provides detailed information about activation records with filtering and sorting options.

• Supports filtering by activation status, type, subscription ID, and date range.
• Returns a list of activation requests with details such as subscription, phone number, and activation status.
• Offers pagination and sorting for optimized data retrieval.

Use this API to efficiently monitor and track activation requests in your system.