api/v1/pools/{id}/sims
Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/pools/{id}/sims?skip={skip}&take={take}&sortBy={sortBy}&sortOrder={sortOrder}
Summary
Get a list of sims using this pool
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The unique Id of a pool |
globally unique identifier |
Required |
skip |
The number of records to skip |
integer |
Default value is 0 |
take |
The number of records to take. Max value: 100 |
integer |
Default value is 100 |
sortBy |
The name of the parameter by which you wish to sort. 'allowanceused' is default. Optional |
string |
Default value is CachedSimView.PercentUsage |
sortOrder |
Enter 'asc' for ascending or 'desc' for descending sort. Optional |
string |
Default value is desc |
Body Parameters
None.
Response Information
Resource Description
Array of Sims
Collection of SimpleSimModelName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
MobileNumber | string |
None. |
|
ICCID | string |
None. |
|
State | SimState |
None. |
|
Operator | string |
None. |
|
CustomerName | string |
None. |
|
SimTag | string |
None. |
|
HasBoltons | boolean |
None. |
|
Tariff | string |
None. |
|
TariffAllowance | integer |
None. |
|
AllowanceUsed | decimal number |
None. |
|
Allowance | integer |
None. |
|
ActivatedDate | date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "935a67e5-f5ea-42a1-9aa8-3f569d0e5c6c", "MobileNumber": "sample string 2", "ICCID": "sample string 3", "State": 0, "Operator": "sample string 4", "CustomerName": "sample string 5", "SimTag": "sample string 6", "HasBoltons": true, "Tariff": "sample string 8", "TariffAllowance": 9, "AllowanceUsed": 10.1, "Allowance": 11, "ActivatedDate": "2024-11-14T20:48:10.3068239+00:00" }, { "Id": "935a67e5-f5ea-42a1-9aa8-3f569d0e5c6c", "MobileNumber": "sample string 2", "ICCID": "sample string 3", "State": 0, "Operator": "sample string 4", "CustomerName": "sample string 5", "SimTag": "sample string 6", "HasBoltons": true, "Tariff": "sample string 8", "TariffAllowance": 9, "AllowanceUsed": 10.1, "Allowance": 11, "ActivatedDate": "2024-11-14T20:48:10.3068239+00:00" } ]
application/xml, text/xml
Sample:
<ArrayOfSimpleSimModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models"> <SimpleSimModel> <ActivatedDate>2024-11-14T20:48:10.3068239+00:00</ActivatedDate> <Allowance>11</Allowance> <AllowanceUsed>10.1</AllowanceUsed> <CustomerName>sample string 5</CustomerName> <HasBoltons>true</HasBoltons> <ICCID>sample string 3</ICCID> <Id>935a67e5-f5ea-42a1-9aa8-3f569d0e5c6c</Id> <MobileNumber>sample string 2</MobileNumber> <Operator>sample string 4</Operator> <SimTag>sample string 6</SimTag> <State>Active</State> <Tariff>sample string 8</Tariff> <TariffAllowance>9</TariffAllowance> </SimpleSimModel> <SimpleSimModel> <ActivatedDate>2024-11-14T20:48:10.3068239+00:00</ActivatedDate> <Allowance>11</Allowance> <AllowanceUsed>10.1</AllowanceUsed> <CustomerName>sample string 5</CustomerName> <HasBoltons>true</HasBoltons> <ICCID>sample string 3</ICCID> <Id>935a67e5-f5ea-42a1-9aa8-3f569d0e5c6c</Id> <MobileNumber>sample string 2</MobileNumber> <Operator>sample string 4</Operator> <SimTag>sample string 6</SimTag> <State>Active</State> <Tariff>sample string 8</Tariff> <TariffAllowance>9</TariffAllowance> </SimpleSimModel> </ArrayOfSimpleSimModel>