api/v1/pools

Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/pools?skip={skip}&take={take}

Summary

Get a list of pools

Request Information

URI Parameters

Name	Description	Type	Additional information
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

Body Parameters

None.

Response Information

Resource Description

Array of Pools

Collection of PoolModel

Name	Description	Type	Additional information
Id		globally unique identifier	None.
Type		string	None.
PoolName		string	None.
Operator		string	None.
Usage		integer	None.
Sims	All SIMs associated with this pool	Collection of SimpleSimModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "0229aa06-b9b4-4126-ac96-1f86a48b844e",
    "Type": "sample string 2",
    "PoolName": "sample string 3",
    "Operator": "sample string 4",
    "Usage": 1,
    "Sims": [
      {
        "Id": "b6932077-0c6c-4619-8d99-2e79b5cd453c",
        "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-14T21:02:23.4108866+00:00"
      },
      {
        "Id": "b6932077-0c6c-4619-8d99-2e79b5cd453c",
        "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-14T21:02:23.4108866+00:00"
      }
    ]
  },
  {
    "Id": "0229aa06-b9b4-4126-ac96-1f86a48b844e",
    "Type": "sample string 2",
    "PoolName": "sample string 3",
    "Operator": "sample string 4",
    "Usage": 1,
    "Sims": [
      {
        "Id": "b6932077-0c6c-4619-8d99-2e79b5cd453c",
        "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-14T21:02:23.4108866+00:00"
      },
      {
        "Id": "b6932077-0c6c-4619-8d99-2e79b5cd453c",
        "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-14T21:02:23.4108866+00:00"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPoolModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models">
  <PoolModel>
    <Id>0229aa06-b9b4-4126-ac96-1f86a48b844e</Id>
    <Operator>sample string 4</Operator>
    <PoolName>sample string 3</PoolName>
    <Sims>
      <SimpleSimModel>
        <ActivatedDate>2024-11-14T21:02:23.4108866+00:00</ActivatedDate>
        <Allowance>11</Allowance>
        <AllowanceUsed>10.1</AllowanceUsed>
        <CustomerName>sample string 5</CustomerName>
        <HasBoltons>true</HasBoltons>
        <ICCID>sample string 3</ICCID>
        <Id>b6932077-0c6c-4619-8d99-2e79b5cd453c</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-14T21:02:23.4108866+00:00</ActivatedDate>
        <Allowance>11</Allowance>
        <AllowanceUsed>10.1</AllowanceUsed>
        <CustomerName>sample string 5</CustomerName>
        <HasBoltons>true</HasBoltons>
        <ICCID>sample string 3</ICCID>
        <Id>b6932077-0c6c-4619-8d99-2e79b5cd453c</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>
    </Sims>
    <Type>sample string 2</Type>
    <Usage>1</Usage>
  </PoolModel>
  <PoolModel>
    <Id>0229aa06-b9b4-4126-ac96-1f86a48b844e</Id>
    <Operator>sample string 4</Operator>
    <PoolName>sample string 3</PoolName>
    <Sims>
      <SimpleSimModel>
        <ActivatedDate>2024-11-14T21:02:23.4108866+00:00</ActivatedDate>
        <Allowance>11</Allowance>
        <AllowanceUsed>10.1</AllowanceUsed>
        <CustomerName>sample string 5</CustomerName>
        <HasBoltons>true</HasBoltons>
        <ICCID>sample string 3</ICCID>
        <Id>b6932077-0c6c-4619-8d99-2e79b5cd453c</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-14T21:02:23.4108866+00:00</ActivatedDate>
        <Allowance>11</Allowance>
        <AllowanceUsed>10.1</AllowanceUsed>
        <CustomerName>sample string 5</CustomerName>
        <HasBoltons>true</HasBoltons>
        <ICCID>sample string 3</ICCID>
        <Id>b6932077-0c6c-4619-8d99-2e79b5cd453c</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>
    </Sims>
    <Type>sample string 2</Type>
    <Usage>1</Usage>
  </PoolModel>
</ArrayOfPoolModel>