api/v1/customers
Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/customers?skip={skip}&take={take}&search={search}&hidden={hidden}&sortBy={sortBy}&sortOrder={sortOrder}
Summary
Get a list of customers that belongs to a reseller by ID and matching selected criteria.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
skip |
Optional, the number of records to skip |
integer |
None. |
take |
Optional, the number of records requested |
integer |
None. |
search |
Optional, customer name or email, can be partial match |
string |
None. |
hidden |
Optional, show hidden customers as default false |
boolean |
None. |
sortBy |
The name of the parameter by which you wish to sort. 'allowanceused' 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 |
Body Parameters
None.
Response Information
Resource Description
List of customers matching criteria.
Collection of CustomerOverviewName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
string |
None. |
||
TotalSims | integer |
None. |
|
UnactivatedSims | integer |
None. |
|
InactiveSims | integer |
None. |
|
ActiveBoltOns | integer |
None. |
|
TotalData | integer |
None. |
|
ActiveSims | integer |
None. |
|
Status | string |
None. |
|
Hidden | boolean |
None. |
|
DefaultPool | string |
None. |
|
DefaultPoolId | globally unique identifier |
None. |
|
DefaultPrivateAPN | string |
None. |
|
DateCreated | date |
None. |
|
ICCID | string |
None. |
Response Formats
application/json, text/json
[ { "Id": "5ac7d5ba-0829-470f-94ff-4da69837f22c", "Name": "sample string 2", "Email": "sample string 3", "TotalSims": 4, "UnactivatedSims": 5, "InactiveSims": 6, "ActiveBoltOns": 7, "TotalData": 8, "ActiveSims": 9, "Status": "sample string 10", "Hidden": true, "DefaultPool": "sample string 12", "DefaultPoolId": "ba5872d0-a29a-4bfb-aa0b-54ecd087156d", "DefaultPrivateAPN": "sample string 14", "DateCreated": "2024-11-14T21:04:45.999257+00:00", "ICCID": "sample string 15" }, { "Id": "5ac7d5ba-0829-470f-94ff-4da69837f22c", "Name": "sample string 2", "Email": "sample string 3", "TotalSims": 4, "UnactivatedSims": 5, "InactiveSims": 6, "ActiveBoltOns": 7, "TotalData": 8, "ActiveSims": 9, "Status": "sample string 10", "Hidden": true, "DefaultPool": "sample string 12", "DefaultPoolId": "ba5872d0-a29a-4bfb-aa0b-54ecd087156d", "DefaultPrivateAPN": "sample string 14", "DateCreated": "2024-11-14T21:04:45.999257+00:00", "ICCID": "sample string 15" } ]
application/xml, text/xml
<ArrayOfCustomerOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JolaSimPortal.Shared.Models.Customer"> <CustomerOverview> <ActiveBoltOns>7</ActiveBoltOns> <ActiveSims>9</ActiveSims> <DateCreated>2024-11-14T21:04:45.999257+00:00</DateCreated> <DefaultPool>sample string 12</DefaultPool> <DefaultPoolId>ba5872d0-a29a-4bfb-aa0b-54ecd087156d</DefaultPoolId> <DefaultPrivateAPN>sample string 14</DefaultPrivateAPN> <Email>sample string 3</Email> <Hidden>true</Hidden> <ICCID>sample string 15</ICCID> <Id>5ac7d5ba-0829-470f-94ff-4da69837f22c</Id> <InactiveSims>6</InactiveSims> <Name>sample string 2</Name> <Status>sample string 10</Status> <TotalData>8</TotalData> <TotalSims>4</TotalSims> <UnactivatedSims>5</UnactivatedSims> </CustomerOverview> <CustomerOverview> <ActiveBoltOns>7</ActiveBoltOns> <ActiveSims>9</ActiveSims> <DateCreated>2024-11-14T21:04:45.999257+00:00</DateCreated> <DefaultPool>sample string 12</DefaultPool> <DefaultPoolId>ba5872d0-a29a-4bfb-aa0b-54ecd087156d</DefaultPoolId> <DefaultPrivateAPN>sample string 14</DefaultPrivateAPN> <Email>sample string 3</Email> <Hidden>true</Hidden> <ICCID>sample string 15</ICCID> <Id>5ac7d5ba-0829-470f-94ff-4da69837f22c</Id> <InactiveSims>6</InactiveSims> <Name>sample string 2</Name> <Status>sample string 10</Status> <TotalData>8</TotalData> <TotalSims>4</TotalSims> <UnactivatedSims>5</UnactivatedSims> </CustomerOverview> </ArrayOfCustomerOverview>