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

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "be088cdd-b559-4f64-a7b5-652b6a523849",
    "Type": "sample string 2",
    "PoolName": "sample string 3",
    "Operator": "sample string 4",
    "Usage": 1,
    "Sims": [
      {
        "Id": "1ab220de-79df-48f1-a907-4c35faff6ce8",
        "ModileNumber": "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
      },
      {
        "Id": "1ab220de-79df-48f1-a907-4c35faff6ce8",
        "ModileNumber": "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
      }
    ]
  },
  {
    "Id": "be088cdd-b559-4f64-a7b5-652b6a523849",
    "Type": "sample string 2",
    "PoolName": "sample string 3",
    "Operator": "sample string 4",
    "Usage": 1,
    "Sims": [
      {
        "Id": "1ab220de-79df-48f1-a907-4c35faff6ce8",
        "ModileNumber": "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
      },
      {
        "Id": "1ab220de-79df-48f1-a907-4c35faff6ce8",
        "ModileNumber": "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
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfPoolModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Controllers">
  <PoolModel>
    <Id>be088cdd-b559-4f64-a7b5-652b6a523849</Id>
    <Operator>sample string 4</Operator>
    <PoolName>sample string 3</PoolName>
    <Sims>
      <SimpleSimModel>
        <CustomerName>sample string 5</CustomerName>
        <HasBoltons>true</HasBoltons>
        <ICCID>sample string 3</ICCID>
        <Id>1ab220de-79df-48f1-a907-4c35faff6ce8</Id>
        <ModileNumber>sample string 2</ModileNumber>
        <Operator>sample string 4</Operator>
        <SimTag>sample string 6</SimTag>
        <State>Active</State>
        <Tariff>sample string 8</Tariff>
        <TariffAllowance>9</TariffAllowance>
      </SimpleSimModel>
      <SimpleSimModel>
        <CustomerName>sample string 5</CustomerName>
        <HasBoltons>true</HasBoltons>
        <ICCID>sample string 3</ICCID>
        <Id>1ab220de-79df-48f1-a907-4c35faff6ce8</Id>
        <ModileNumber>sample string 2</ModileNumber>
        <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>be088cdd-b559-4f64-a7b5-652b6a523849</Id>
    <Operator>sample string 4</Operator>
    <PoolName>sample string 3</PoolName>
    <Sims>
      <SimpleSimModel>
        <CustomerName>sample string 5</CustomerName>
        <HasBoltons>true</HasBoltons>
        <ICCID>sample string 3</ICCID>
        <Id>1ab220de-79df-48f1-a907-4c35faff6ce8</Id>
        <ModileNumber>sample string 2</ModileNumber>
        <Operator>sample string 4</Operator>
        <SimTag>sample string 6</SimTag>
        <State>Active</State>
        <Tariff>sample string 8</Tariff>
        <TariffAllowance>9</TariffAllowance>
      </SimpleSimModel>
      <SimpleSimModel>
        <CustomerName>sample string 5</CustomerName>
        <HasBoltons>true</HasBoltons>
        <ICCID>sample string 3</ICCID>
        <Id>1ab220de-79df-48f1-a907-4c35faff6ce8</Id>
        <ModileNumber>sample string 2</ModileNumber>
        <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>