api/v1/customers/{id}/sims/
Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/customers/{id}/sims?skip={skip}&take={take}&sortBy={sortBy}&sortOrder={sortOrder}&state={state}&includeDecommissioned={includeDecommissioned}
Summary
Get a list of SIMs that are associated to a customer
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The id of the customer |
globally unique identifier |
Required |
skip |
The number of records to skip |
integer |
Default value is 0 |
take |
The number of records requested |
integer |
Default value is 10 |
sortBy |
The name of the parameter by which you wish to sort. 'ICCID' is default. Optional |
string |
None. |
sortOrder |
Enter 'asc' for ascending or 'desc' for descending sort. Ascending is default behaviour. Optional |
string |
Default value is asc |
state |
The SIM State string to filter to |
string |
Default value is |
includeDecommissioned |
Include sims that are in a Decommissioned State |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of SimModelName | Description | Type | Additional information |
---|---|---|---|
Allownace | integer |
None. |
|
Barred | boolean |
None. |
|
BoltonAllowance | integer |
None. |
|
ContactEmail | string |
None. |
|
ContactMobileNumber | string |
None. |
|
SimTag | string |
None. |
|
HasBoltons | boolean |
None. |
|
ICCID | string |
None. |
|
Id | globally unique identifier |
None. |
|
MobileNumber | string |
None. |
|
Operator | string |
None. |
|
LastSeenCountry | string |
None. |
|
LastSeenNetwork | string |
None. |
|
LastSeenAt | date |
None. |
|
AllowanceUsedPercent | decimal number |
None. |
|
ActivatedDate | date |
None. |
|
State | SimState |
None. |
|
Tariff | string |
None. |
|
TariffAllowance | integer |
None. |
|
Usage | integer |
None. |
|
CustomerId | globally unique identifier |
None. |
|
QRPayload | string |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.