QuerySimcard

Overview

Method: GET
Endpoint: /api/QuerySimcard
Description: Retrieves information about one or more SIM cards based on the provided filters.

This endpoint allows querying for SIM card details, including their status, type, associated subscription, and activation date.

GET /api/QuerySimcard

Query Parameters

You can refine the search using the following optional parameters:

simCardNumber (string, optional): Filter results by a specific SIM card number.
status (string, optional): Filter by SIM card status (FREE, ACTIVATED, DISABLED, BUSY).
simCardType(string, optional): Filter by SIM card type (USIM, DUOSIM, DATAONLYSIM).
subscriptionId (string, optional): Filter by the associated subscription ID.
phoneNumber (string, optional): Filter by the associated phone number.
activatedDateFrom (string, optional): Start date of activation period (ISO 8601: YYYY-MM-DD).
activatedDateTo (string, optional): End date of activation 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): Sort results in ascending or descending order by a specific field.

Response Structure

The API returns an array of objects representing SIM cards. Each object includes the following properties:

{  
    "id": "######XRGv####NKW",
    "simCardNumber": "89310836########76",
    "status": "ACTIVATED",
    "simCardType": "USIM",
    "pin": "0000",
    "puk": "####010",
    "subscriptionId": "string",
    "phoneNumber": "06-######81",
    "activatedDate": "2024-10-21T23:53:26+02:00"
}

Field Descriptions

id: Unique identifier for the SIM card.
simCardNumber: The assigned SIM card number.
status: The SIM card’s current state. Possible values: FREE, ACTIVATED, DISABLED, BUSY.
simCardType: Type of SIM card (USIM, DUOSIM, DATAONLYSIM)^*.
pin: The associated PIN code (if available).
puk: The associated PUK code (if available).
subscriptionId: The ID of the related subscription (if applicable).
phoneNumber: The assigned phone number (if applicable).
activatedDate: The date and time the SIM card was activated (if applicable).

^{* simcard types:}

USIM: Universal Subscriber Identity Module, standard SIM card for mobile devices
DUOSIM: Duo SIM card, capable of holding two different mobile numbers
DATAONLYSIM: SIM card for data-only devices, without voice capabilities

Info

Returned fields may vary depending on the SIM card’s status.

Usage Notes

Use this API to retrieve information about one or more SIM cards.
If filtering by status, ensure values are one of: FREE, ACTIVATED, DISABLED, BUSY.
The simCardType field can be one of: USIM, DUOSIM, DATAONLYSIM.
The subscriptionId and phoneNumber fields may be null if not applicable.
Use pagination (take and skip) to manage large result sets.
orderBy and orderByDesc allow sorting results by a specific field.
activatedDateFrom and activatedDateTo must follow the ISO 8601 format: YYYY-MM-DD.

Example Requests

Retrieve information for a specific SIM card

GET /api/QuerySimcard?simCardNumber=8931234567890123456

Get the first 50 activated SIM cards, sorted by activation date

GET /api/QuerySimcard?status=ACTIVATED&take=50&orderByDesc=activatedDate

Find all free `DATAONLYSIM` cards

GET /api/QuerySimcard?status=FREE&simCardType=DATAONLYSIM

Retrieve SIM cards activated within a specific date range

GET /api/QuerySimcard?activatedDateFrom=2023-01-01&activatedDateTo=2023-12-31

Summary

The /api/QuerySimcard endpoint provides detailed information on available SIM cards with filtering options for status, type, activation period, and sorting.

Supports filtering by SIM card number, status, type, and more.
Returns a list of SIM cards with details such as status, subscription, and phone number.
Offers pagination and sorting options for optimized data retrieval.

Use this API to efficiently manage and retrieve SIM card data based on your needs.