api/v1/pools/{id}

Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/pools/{id}

Summary

Get a pool

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique Id of a pool

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

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": "c2e48941-992d-44bb-b28d-543a6f329150",
  "Type": "sample string 2",
  "PoolName": "sample string 3",
  "Operator": "sample string 4",
  "Usage": 1,
  "Sims": [
    {
      "Id": "afedca4b-0ea2-410b-b8ce-d5c6aa2a2756",
      "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": "afedca4b-0ea2-410b-b8ce-d5c6aa2a2756",
      "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:
<PoolModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Controllers">
  <Id>c2e48941-992d-44bb-b28d-543a6f329150</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>afedca4b-0ea2-410b-b8ce-d5c6aa2a2756</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>afedca4b-0ea2-410b-b8ce-d5c6aa2a2756</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>