QuerySubscription

• Method: GET
• Path: /api/QuerySubscription
• Description: Retrieves a list of subscriptions based on specified criteria.

Query Parameters

GET /api/QuerySubscription

The allowed parameters

• phoneNumber (string, optional): Filter by the phone number
• simCardNumber (string, optional): Filter by SIM card number
• activationDate (string, optional): Filter by activation date (ISO 8601 format: YYYY-MM-DD)
• take (integer, optional): Number of results to return
• skip (integer, optional): Number of results to skip (for pagination)
• orderBy / orderByDesc (string, optional): Sorting criteria
• fields (string, optional): Comma-separated list of fields to include in the response

Response Structure

The response will be an array of Subscription objects, each containing the following fields:

{
    "offset": 0,
    "total": 0,
    "results": [{
        "id": "###3Vp17###7Xg79e",
        "state": "ACTIVE",
        "phoneNumber": "06-######969",
        "simCardNumber": "893####4077444062",
        "pin": "0000",
        "puk": "#####204",
        "providerGroup": "KPNMOBIEL",
        "isDataSim": false,
        "isEsim": true,
        "activationDate": "2025-01-31",
        "fixedIpAddress": "89.200.101.166",
        "providerEnvironment": "SP16001",
        "services": {
            "voiceMail": true,
            "voiceRoaming": true,
            "internationalDialing": true,
            "premiumServices": true,
            "entertainmentServices": true,
            "dataUsageNotification": "Data Usage Notification 1000 MB",
            "accessType": "Internet Access",
            "internetAccess": true,
            "mobilePay": false,
            "blockData": false,
            "dataRoamingEU": true,
            "notificationInfo": true,
            "unlimitedVoiceNLEUGroup": true,
            "dataRoamingLimitation": "Limit 50",
            "dataRoamingLimitationNotification": true,
            "dataRoamingLimitationOverrideAllowed": true,
            "dataRoamingOutsideEU": true,
            "blockExceptionCountries": false,
            "blockSatelliteDestinations": false,
            "fixedIp": true,
            "benefitCountriesA15000MB": true,
            "benefitCountriesA15000MBMax": false,
            "benefitCountriesB7500MB": true,
            "benefitCountriesB7500MBMax": false,
            "restOfTheWorld5000MB": true,
            "restOfTheWorld5000MBMax": false,
            "worldBundle7500MB": false,
            "voicePriority": false
        }
    }],
    "meta": {}
}

Field Descriptions

• id: The unique ID of the subscription.
• state: The current status of the subscription:
  • ACTIVE, BLOCKED or UNKNOWN.
• isDataSim: If the subscription is a datasim only.
• phoneNumber: The assigned phone number.
• simCardNumber: The simcardnumber.
• pin: The pincode of the simcard.
• puk: The pukcode of the simcard.
• activationDate: The date and time when activation of sim was completed.
• providerGroup: Allways set to 'KPNMOBIEL'.
• providerEnvironment: The Envirionment where the sim is registered at the provider.
• fixedIpAddress: If a fixed IP is requested and is set, the IP will be displayed here.^*
• services: The object with actual set services on the subscription.

Warning

^* If you enable the 'fixedIP' service, you may need to update the phone's APN settings for it to take effect. Please contact the service department if you're unsure how to configure the APN settings correctly. ^* If the service fixedIP is set to false again, the formerly assigned IP address will not be erased!

Usage Notes

• Use this endpoint to retrieve information about one or more subscriptions.
• You can combine multiple query parameters to narrow down your search.
• The fields parameter allows you to limit the data returned for each subscription, which can be useful for optimizing response size and processing time.
• Use pagination parameters (take and skip) to handle large result sets efficiently.
• The orderBy and orderByDesc parameters can be used to sort the results based on specific fields.
• The activationDate parameter should use ISO 8601 format: YYYY-MM-DD.

Example Requests

Retrieve subscriptions by phone number:

GET /api/QuerySubscription?phoneNumber=06-12345678

Get the first 50 subscriptions, sorted by activation date:

GET /api/QuerySubscription?take=50&orderByDesc=activationDate

Find subscriptions with a specific SIM card number:

GET /api/QuerySubscription?simCardNumber=8931234567890123456

Retrieve specific fields for subscriptions activated on a certain date:

GET /api/QuerySubscription?activationDate=2023-01-01&fields=id,phoneNumber,simCardNumber,activationDate